Output Variables

Palette Dev Engine output variables are defined in the app profile and are only resolved at cluster deployment time. The output variables have the following properties:

  • May be referenced by specifying them during app profile creation.

  • Output variables are inherited from the lower tiers of the app profile.

  • Each service type exposes a set of unique output variables.

The variables are generated when the server layer is deployed. Output variables can be consumed by the higher layers in the app profile.

Check out the Services Connectivity page to learn how to use output variables for establishing network connectivity between services.


{{.spectro.app.$appdeploymentName.<tiername>.<tierOutput_Variable_Name>}}

System Output Variables

The following output variables are globally available for all services.

Output VariableDescription
spectro.system.user.nameThe user name of the logged in user.
spectro.system.user.uidThe id of the logged in user.
spectro.system.user.emailThe email address of the logged in user.
spectro.system.tenant.uid The id of the current tenant or organization.
spectro.system.project.uidThe id of the current project.
spectro.system.project.nameThe name of the current project.
spectro.system.cluster.uidThe id of the current cluster.
spectro.system.cluster.nameThe name of the current cluster.
spectro.system.kubernetes.versionThe current version of Kubernetes.
spectro.system.reverseproxy.serverThe hostname of the Spectro Cloud reverse proxy server. This value is empty when not enabled.
spectro.system.reverseproxy.portThe port of the Spectro Cloud reverse proxy server. This value is empty when not enabled.
spectro.system.reverseproxy.vhostportThe port of the virtual host that is hosting the reverse proxy.
spectro.system.reverseproxy.protocolThe protocol used for the Spectro Cloud reverse proxy.
spectro.system.cloud.typeThe type of cloud environment where the cluster is deployed, such as EKS, AKS, and GKE.
spectro.system.cloud.regionThe cloud provider region where the cluster is deployed.
spectro.system.apptier.nameThe name of the service layer from the context of the app profile.
spectro.system.apptier.uidThe id of the service layer.
spectro.system.appprofile.nameThe name of the app profile.
spectro.system.appprofile.uidThe id of the app profile.
spectro.system.appdeployment.uidThe id of the app deployment.
spectro.system.appdeployment.nameThe name of the app deployment.
spectro.system.appdeployment.tiernameThe name of the service layer from the context of the app deployment.
spectro.system.appdeployment.ingress.hostThe ingress host pattern for a cluster group with ingress enabled. This value is dynamically generated.

Container Service Output Variables

The container service type exposes the following output variables. Replace [service-name] with the respective name of the service layer.

Output VariableDescription
.spectro.app.$appDeploymentName.[service-name].CONTAINER_NAMESPACEThe Kubernetes namespace of the deployed container.
.spectro.app.$appDeploymentName.[service-name].CONTAINER_SVCThe Kubernetes DNS hostname of the service.
.spectro.app.$appDeploymentName.[service-name].CONTAINER_SVC_PORTThe exposed port of the service.
spectro.app.$appDeploymentName.[service-name].CONTAINER_SVC_EXTERNALHOSTNAMEThe Kubernetes DNS hostname of the load balancer. This value is available if the service's to Public and deployed to a public cloud provider environment.
spectro.app.$appDeploymentName.[service-name].CONTAINER_SVC_EXTERNALIPThe public URL of the load balancer. This value is available if the service's access is set to Public and deployed to a private cloud provider environment.

Database Service Output Variables

Each database service exposes a set of output variables. Review each database service for more details. You can find information about each database service by checking out the Available Services resource.

Resources