Expose Deployments

You can use predefined objectOutputRefs to expose an App Deployment's or model deployment's service, ingress, or gateway (HTTP route). Adding predefined objectOutputRefs to your application's workload profile allows you to access your application by selecting a button instead of visiting a URL or IP address.

Prerequisites

• Permission to create or edit WorkloadProfile resources.

• Knowledge of the name and namespace of the application's or model's service, ingress, or gateway (HTTP route)

• (Applications or models with an ingress) The application's or model's SSL certificate; otherwise, HTTPS will be unavailable.

Enablement

1. Log in to PaletteAI.

2. From the left main menu, select Workload Profiles.

3. Create a new workload profile or modify an existing profile.

   • New workload profile - Select Create Workload Profile.
   • Modify existing workload profile - Select the profile name to open its details page, and then select Create Version. When basic versioning is enabled, the button is labeled Create Revision.

4. Complete the appropriate workload profile fields. A workload profile name and type (application, model, or infrastructure) are required. When semantic versioning is enabled, an update type (patch, minor, or major) is also required. The name and type cannot be modified if creating a new profile version. Select Next when finished.

5. Select an existing component from the stack or select Add component. If adding a new component, complete the applicable component fields. Fields vary based on the component type.

6. In the top-right of the profile pane, select Object outputs. In the Object Outputs drawer, select Add Object Output.

7. In the Add Object Output drawer, choose Namespace for Choose a kubernetes resource scope, and enter the following values based on whether you are exposing the application's or model's service, ingress, or gateway. You must create a separate object output for each Output name in the table below.

   Refer to our Outputs reference guide for additional details.

   warning

   The Resource Name and Namespace values must match metadata.name and metadata.namespace of the service, ingress, or gateway. You can use Variables to define these values and use macros in these fields (for example, {{ .var.clearml-namespace }}).

   Service

   Output Name	API Version	Kind	Path
   webserverIp	v1	Service	.status.loadBalancer.ingress[0].ip
   webserverPort	v1	Service	.spec.ports[0].port

   Ingress

   info

   Defining an httpScheme is optional. If undefined, http:// is used by default.

   To determine whether to expose the URL with an HTTP or HTTPS prefix, the ingress's spec.tls.[0].hosts[0] is inspected. If an entry is found in the list, PaletteAI prepends https:// to the URL when a user selects the Access button. Otherwise, http:// is prefixed.

   Output Name	API Version	Kind	Path
   ingressDomain	networking.k8s.io/v1	Ingress	.spec.rules[0].host
   ingressPath	networking.k8s.io/v1	Ingress	.spec.rules[0].http.paths[0].path
   httpScheme	networking.k8s.io/v1	Ingress	.spec.tls[0].hosts[0]

   Gateway

   info

   Defining an httpScheme is optional. If undefined, http:// is used by default.

   To determine whether to expose the URL with an HTTP or HTTPS prefix, the gateway's spec.listeners[0].protocol is inspected. If the protocol value is exactly HTTPS, PaletteAI prepends https:// to the URL when a user selects the Access button. Otherwise, http:// is prefixed.

   Note that depending on your environment setup, the correct index may not be 0. Review your listeners and select the appropriate listener for your gateway.

   Output Name	API Version	Kind	Path
   gatewayDomain	gateway.networking.k8s.io/v1	HTTPRoute	.spec.hostnames[0]
   gatewayPath	gateway.networking.k8s.io/v1	HTTPRoute	.spec.rules[0].matches[0].path.value
   httpScheme	gateway.networking.k8s.io/v1	Gateway	.spec.listeners[0].protocol

8. (Optional) Configure the following options, if desired:

   • Skip Hash - Prevent the workload from being redeployed when only the output value changes. Useful for outputs that change frequently but do not require the app to be redeployed.
   • Deployment Priority - Found under Assign output to deployment priority. Specify when this output should be resolved. If provided, the output is resolved at the specified deployment priority; otherwise, the output is resolved after the final deployment priority. Refer to the Deployment Priorities reference for more information.

9. Select Add to complete your object output setup. When editing an existing output, the button is labeled Save. Repeat steps 7 - 8 until all required outputs are added for your application or model.

10. Close the Object Outputs drawer. Select Next.

11. Review your workload profile configuration and select Submit.

Validate

1. Log in to PaletteAI.

2. From the left main menu, select Workload Profiles.

3. Select the applicable workload profile name to open its details page.

4. In the bottom-left of the profile editor, select the </> button to open the YAML editor. If you have multiple workload profile versions, use the version drop-down menu to ensure you are on the version containing the predefined object outputs.

   

5. Scroll to the spec.workload.objectOutputRefs section of your workload profile YAML and confirm the YAML contains the expected values. The following example is for an application exposed via a service.

   Example objectOutputRefs for service

   spec:
     workload:
       objectOutputRefs:
         - name: webserverIp
           pathRef:
             apiVersion: v1
             kind: Service
             path: .status.loadBalancer.ingress[0].ip
             name: clearml-webserver
             namespace: '{{ .var.clearml-namespace }}'
           skipHash: false
         - name: webserverPort
           pathRef:
             apiVersion: v1
             kind: Service
             path: .spec.ports[0].port
             name: clearml-webserver
             namespace: '{{ .var.clearml-namespace }}'
           skipHash: false

6. If you have an application or model deployed with a workload profile, navigate to the left main menu and select either App Deployments or Model Deployments.

7. Select your application or model to open its overview page. For an App Deployment, select Access Endpoints and choose an endpoint to open your application in a new browser tab. For a Model Deployment, select Access App in the Platform URL row. For example, using the previous objectOutputRefs for a ClearML application opens the following web page.