Application

pydantic model phalanx.models.applications.Application

A Phalanx application that knows which environments use it.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "Application",
   "description": "A Phalanx application that knows which environments use it.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "namespace": {
         "title": "Namespace",
         "type": "string"
      },
      "chart": {
         "title": "Chart",
         "type": "object"
      },
      "doc_links": {
         "title": "Doc Links",
         "type": "array",
         "items": {
            "$ref": "#/definitions/DocLink"
         }
      },
      "values": {
         "title": "Values",
         "type": "object"
      },
      "environment_values": {
         "title": "Environment Values",
         "type": "object",
         "additionalProperties": {
            "type": "object"
         }
      },
      "secrets": {
         "title": "Secrets",
         "type": "object",
         "additionalProperties": {
            "$ref": "#/definitions/ConditionalSecretConfig"
         }
      },
      "environment_secrets": {
         "title": "Environment Secrets",
         "type": "object",
         "additionalProperties": {
            "type": "object",
            "additionalProperties": {
               "$ref": "#/definitions/ConditionalSecretConfig"
            }
         }
      },
      "active_environments": {
         "title": "Active Environments",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "required": [
      "name",
      "namespace",
      "chart",
      "doc_links",
      "values",
      "environment_values",
      "secrets",
      "environment_secrets",
      "active_environments"
   ],
   "definitions": {
      "DocLink": {
         "title": "DocLink",
         "description": "A documentation link for an application.\n\nThis represents an individual array item in the ``phalanx.lsst.io/docs``\nHelm chart annotation in :file:`Chart.yaml`.",
         "type": "object",
         "properties": {
            "url": {
               "title": "Url",
               "type": "string"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            }
         },
         "required": [
            "url",
            "title"
         ]
      },
      "ConditionalSecretCopyRules": {
         "title": "ConditionalSecretCopyRules",
         "description": "Possibly conditional rules for copying a secret value from another.",
         "type": "object",
         "properties": {
            "if": {
               "title": "Condition",
               "description": "Configuration only applies if this Helm chart setting is set to a true value",
               "type": "string"
            },
            "application": {
               "title": "Application",
               "type": "string"
            },
            "key": {
               "title": "Key",
               "type": "string"
            }
         },
         "required": [
            "application",
            "key"
         ],
         "additionalProperties": false
      },
      "ConditionalSimpleSecretGenerateRules": {
         "title": "ConditionalSimpleSecretGenerateRules",
         "description": "Conditional rules for generating a secret value with no source.",
         "type": "object",
         "properties": {
            "if": {
               "title": "Condition",
               "description": "Configuration only applies if this Helm chart setting is set to a true value",
               "type": "string"
            },
            "type": {
               "title": "Type",
               "enum": [
                  "password",
                  "gafaelfawr-token",
                  "fernet-key",
                  "rsa-private-key"
               ],
               "type": "string"
            }
         },
         "required": [
            "type"
         ],
         "additionalProperties": false
      },
      "ConditionalSourceSecretGenerateRules": {
         "title": "ConditionalSourceSecretGenerateRules",
         "description": "Conditional rules for generating a secret from another secret.",
         "type": "object",
         "properties": {
            "if": {
               "title": "Condition",
               "description": "Configuration only applies if this Helm chart setting is set to a true value",
               "type": "string"
            },
            "type": {
               "title": "Type",
               "enum": [
                  "bcrypt-password-hash",
                  "mtime"
               ],
               "type": "string"
            },
            "source": {
               "title": "Source",
               "type": "string"
            }
         },
         "required": [
            "type",
            "source"
         ]
      },
      "ConditionalSecretConfig": {
         "title": "ConditionalSecretConfig",
         "description": "Possibly conditional specification for an application secret.",
         "type": "object",
         "properties": {
            "if": {
               "title": "Condition",
               "description": "Configuration only applies if this Helm chart setting is set to a true value",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "type": "string"
            },
            "copy": {
               "title": "Copy",
               "description": "Rules for where the secret should be copied from",
               "allOf": [
                  {
                     "$ref": "#/definitions/ConditionalSecretCopyRules"
                  }
               ]
            },
            "generate": {
               "title": "Generate",
               "anyOf": [
                  {
                     "$ref": "#/definitions/ConditionalSimpleSecretGenerateRules"
                  },
                  {
                     "$ref": "#/definitions/ConditionalSourceSecretGenerateRules"
                  }
               ]
            },
            "value": {
               "title": "Value",
               "type": "string",
               "writeOnly": true,
               "format": "password"
            }
         },
         "required": [
            "description"
         ],
         "additionalProperties": false
      }
   }
}

Fields:

• active_environments (list[str])

• chart (dict[str, typing.Any])

• doc_links (list[phalanx.models.applications.DocLink])

• environment_secrets (dict[str, dict[str, phalanx.models.secrets.ConditionalSecretConfig]])

• environment_values (dict[str, dict[str, typing.Any]])

• name (str)

• namespace (str)

• secrets (dict[str, phalanx.models.secrets.ConditionalSecretConfig])

• values (dict[str, typing.Any])

field active_environments: list[str] [Required]

Environments on which this application is enabled.

field chart: dict[str, Any] [Required]

Parsed Helm Chart.yaml file.

field doc_links: list[DocLink] [Required]

List of links to documentation about this application.

field environment_secrets: dict[str, dict[str, ConditionalSecretConfig]] [Required]

Per-environment secrets for the application, by secret key.

field environment_values: dict[str, dict[str, Any]] [Required]

Per-environment Helm chart overrides by environment name.

field name: str [Required]

Name of the application.

field namespace: str [Required]

Namespace to which the application is deployed.

field secrets: dict[str, ConditionalSecretConfig] [Required]

Secrets for the application, by secret key.

field values: dict[str, Any] [Required]

Base Helm chart values.

property homepage: str | None

The Helm home field, typically used for the application’s docs.

property source_urls: list[str]

Application source URLs from the Helm sources field.