values.emporium.yaml File
At its heart, an app is a Helm chart that contains a unique values.emporium.yaml file. This file delineates how Emporium should configure your app and what inputs it needs from the user. It serves as a template for the values fed into helm install.
Available Variables
This section lists all variables available within values.emporium.yaml.
| Variable | Description |
|---|---|
.Emporium.Name | The name of the app instance, input by the user in the Emporium UI. |
.Emporium.Annotations | Annotations for ingresses, configured automatically by Emporium. |
.Emporium.UserSupplied.[your-variable-name] | User-supplied values, specified by the @userSupplied syntax. |
DNS Integration
The following variables are provided by the DNS integration.
| Variable | Description |
|---|---|
.Emporium.Integrations.DNS.Hostname | Hostname for the application, input by the user in the Emporium UI. (eg. myapp.funupupu.io) |
.Emporium.Integrations.DNS.Zone | DNS Zone of the deployment. (eg. funupupu.io) |
.Emporium.Integrations.DNS.Subdomain | Subdomain of the application (eg. myapp) |
OIDC Integration
The following variables are provided by the OIDC integration.
| Variable | Description |
|---|---|
.Emporium.Integrations.OIDC.ClientID | OIDC client id |
.Emporium.Integrations.OIDC.ClientSecret | OIDC client secret |
.Emporium.Integrations.OIDC.ConfigurationEndpoint | OIDC configuration endpoint (/.well-known/openid-configuration) |
.Emporium.Integrations.OIDC.Issuer | OIDC issuer |
Storage Integration
The following variables are provided by the storage integration.
| Variable | Description |
|---|---|
.Emporium.Integrations.Storage.Claims | Map of storage claims. |
.Emporium.Integrations.Storage.Claims.[Key].Name | Name of the storage claim identified by [Key]. |
.Emporium.Integrations.Storage.Claims.[Key].StorageClass | Storage class of storage claims. |
.Emporium.Integrations.Storage.Claims.[Key].Capacity | Capacatiy of the storage claim (e.g. 100Gi or 2Ti). |
Email / SMTP Integration
The following variables are provided by the smtp integration.
| Variable | Description |
|---|---|
.Emporium.Integrations.SMTP.Host | SMTP hostname, configured by the user in the Emporium UI. |
.Emporium.Integrations.SMTP.Port | SMTP port, configured by the user in the Emporium UI. |
.Emporium.Integrations.SMTP.Username | SMTP username, configured by the user in the Emporium UI. |
.Emporium.Integrations.SMTP.Password | SMTP password, configured by the user in the Emporium UI. |
.Emporium.Integrations.SMTP.From | SMTP from email address, configured by the user in the Emporium UI. |
.Emporium.Integrations.SMTP.ReplyTo | SMTP reply to email address, configured by the user in the Emporium UI. |
User Supplied Variables
All variables in the form of .Emporium.UserSupplied.[your-variable-name] will have to have a corresponding @userSupplied definition.
Check out the @userSupplied documentation for a more detailed explanation.
Integrations
Emporium discovers automatically which integrations an app references in it's values.emporium.yaml file. It will render the install screen based on the used integrations and ´@userSupplied´ values.
For example, if an app uses the SMTP / Email integration, Emporium will render a dropdown menu where users can select an email account.
Rendering Process
The following diagram illustrates the process how values.emporium.yaml is used to install an app in your cluster.