Internals

This documentation of the internal implementation details of Phalanx is intended primarily for people doing development on the Phalanx infrastructure itself, as opposed to a Phalanx application or environment. Most users of Phalanx and administrators of Phalanx environments do not need to know this information.

Reference

• JSON schema
• Phalanx internal API
  • phalanx Package
    • Variables
      • __version__
        • __version__
  • phalanx.constants Module
    • Variables
      • HELM_DOCLINK_ANNOTATION
        • HELM_DOCLINK_ANNOTATION
      • PULL_SECRET_DESCRIPTION
        • PULL_SECRET_DESCRIPTION
      • VAULT_WRITE_TOKEN_LIFETIME
        • VAULT_WRITE_TOKEN_LIFETIME
      • VAULT_WRITE_TOKEN_WARNING_LIFETIME
        • VAULT_WRITE_TOKEN_WARNING_LIFETIME
  • phalanx.docs.crossref Module
    • Functions
      • setup
        • setup()
  • phalanx.docs.jinja Module
    • Functions
      • build_jinja_contexts
        • build_jinja_contexts()
  • phalanx.exceptions Module
    • Classes
      • ApplicationExistsError
        • ApplicationExistsError
      • HelmFailedError
        • HelmFailedError
      • InvalidApplicationConfigError
        • InvalidApplicationConfigError
      • InvalidEnvironmentConfigError
        • InvalidEnvironmentConfigError
      • InvalidSecretConfigError
        • InvalidSecretConfigError
      • NoOnepasswordCredentialsError
        • NoOnepasswordCredentialsError
      • UnknownEnvironmentError
        • UnknownEnvironmentError
      • UnresolvedSecretsError
        • UnresolvedSecretsError
      • VaultNotFoundError
        • VaultNotFoundError
    • Class Inheritance Diagram
  • phalanx.factory Module
    • Classes
      • Factory
        • Factory
          • Factory.create_application_service()
          • Factory.create_config_storage()
          • Factory.create_secrets_service()
          • Factory.create_vault_service()
    • Class Inheritance Diagram
  • phalanx.models.applications Module
    • Classes
      • Application
        • Application
          • Application.active_environments
          • Application.chart
          • Application.doc_links
          • Application.environment_secrets
          • Application.environment_values
          • Application.name
          • Application.namespace
          • Application.secrets
          • Application.values
          • Application.homepage
          • Application.source_urls
      • ApplicationConfig
        • ApplicationConfig
          • ApplicationConfig.chart
          • ApplicationConfig.doc_links
          • ApplicationConfig.environment_secrets
          • ApplicationConfig.environment_values
          • ApplicationConfig.name
          • ApplicationConfig.namespace
          • ApplicationConfig.secrets
          • ApplicationConfig.values
          • ApplicationConfig.homepage
          • ApplicationConfig.source_urls
      • ApplicationInstance
        • ApplicationInstance
          • ApplicationInstance.chart
          • ApplicationInstance.environment
          • ApplicationInstance.name
          • ApplicationInstance.secrets
          • ApplicationInstance.values
          • ApplicationInstance.all_static_secrets()
          • ApplicationInstance.is_values_setting_true()
      • DocLink
        • DocLink
          • DocLink.id
          • DocLink.title
          • DocLink.url
          • DocLink.to_rst()
    • Class Inheritance Diagram
  • phalanx.models.environments Module
    • Classes
      • Environment
        • Environment
          • Environment.applications
          • Environment.fqdn
          • Environment.name
          • Environment.onepassword
          • Environment.vault_path_prefix
          • Environment.vault_url
          • Environment.all_applications()
          • Environment.all_secrets()
          • Environment.dict()
          • Environment.json()
          • Environment.vault_path
          • Environment.vault_read_approle
          • Environment.vault_read_policy
          • Environment.vault_write_policy
          • Environment.vault_write_token
      • EnvironmentBaseConfig
        • EnvironmentBaseConfig
          • EnvironmentBaseConfig.fqdn
          • EnvironmentBaseConfig.name
          • EnvironmentBaseConfig.onepassword
          • EnvironmentBaseConfig.vault_path_prefix
          • EnvironmentBaseConfig.vault_url
          • EnvironmentBaseConfig.dict()
          • EnvironmentBaseConfig.json()
          • EnvironmentBaseConfig.vault_path
          • EnvironmentBaseConfig.vault_read_approle
          • EnvironmentBaseConfig.vault_read_policy
          • EnvironmentBaseConfig.vault_write_policy
          • EnvironmentBaseConfig.vault_write_token
      • EnvironmentConfig
        • EnvironmentConfig
          • EnvironmentConfig.applications
          • EnvironmentConfig.butler_repository_index
          • EnvironmentConfig.fqdn
          • EnvironmentConfig.name
          • EnvironmentConfig.onepassword
          • EnvironmentConfig.onepassword_uuid
          • EnvironmentConfig.repo_url
          • EnvironmentConfig.target_revision
          • EnvironmentConfig.vault_path_prefix
          • EnvironmentConfig.vault_url
          • EnvironmentConfig.dict()
          • EnvironmentConfig.json()
          • EnvironmentConfig.enabled_applications
          • EnvironmentConfig.vault_path
          • EnvironmentConfig.vault_read_approle
          • EnvironmentConfig.vault_read_policy
          • EnvironmentConfig.vault_write_policy
          • EnvironmentConfig.vault_write_token
      • EnvironmentDetails
        • EnvironmentDetails
          • EnvironmentDetails.applications
          • EnvironmentDetails.argocd_rbac
          • EnvironmentDetails.argocd_url
          • EnvironmentDetails.fqdn
          • EnvironmentDetails.gafaelfawr_scopes
          • EnvironmentDetails.identity_provider
          • EnvironmentDetails.name
          • EnvironmentDetails.onepassword
          • EnvironmentDetails.vault_path_prefix
          • EnvironmentDetails.vault_url
          • EnvironmentDetails.dict()
          • EnvironmentDetails.json()
          • EnvironmentDetails.argocd_rbac_csv
          • EnvironmentDetails.vault_path
          • EnvironmentDetails.vault_read_approle
          • EnvironmentDetails.vault_read_policy
          • EnvironmentDetails.vault_write_policy
          • EnvironmentDetails.vault_write_token
      • GafaelfawrGitHubGroup
        • GafaelfawrGitHubGroup
          • GafaelfawrGitHubGroup.github
          • GafaelfawrGitHubGroup.to_rst()
      • GafaelfawrGitHubTeam
        • GafaelfawrGitHubTeam
          • GafaelfawrGitHubTeam.organization
          • GafaelfawrGitHubTeam.team
      • GafaelfawrScope
        • GafaelfawrScope
          • GafaelfawrScope.groups
          • GafaelfawrScope.scope
          • GafaelfawrScope.groups_as_rst()
      • IdentityProvider
        • IdentityProvider
          • IdentityProvider.CILOGON
          • IdentityProvider.GITHUB
          • IdentityProvider.NONE
          • IdentityProvider.OIDC
      • OnepasswordConfig
        • OnepasswordConfig
          • OnepasswordConfig.connect_url
          • OnepasswordConfig.vault_title
          • OnepasswordConfig.dict()
          • OnepasswordConfig.json()
      • PhalanxConfig
        • PhalanxConfig
          • PhalanxConfig.applications
          • PhalanxConfig.environments
    • Class Inheritance Diagram
  • phalanx.models.gafaelfawr Module
    • Classes
      • Token
        • Token
          • Token.key
          • Token.secret
          • Token.from_str()
          • Token.is_token()
    • Class Inheritance Diagram
  • phalanx.models.helm Module
    • Classes
      • HelmStarter
        • HelmStarter
          • HelmStarter.EMPTY
          • HelmStarter.WEB_SERVICE
    • Class Inheritance Diagram
  • phalanx.models.secrets Module
    • Classes
      • ConditionalMixin
        • ConditionalMixin
          • ConditionalMixin.condition
      • ConditionalSecretConfig
        • ConditionalSecretConfig
          • ConditionalSecretConfig.condition
          • ConditionalSecretConfig.copy_rules
          • ConditionalSecretConfig.description
          • ConditionalSecretConfig.generate
          • ConditionalSecretConfig.onepassword
          • ConditionalSecretConfig.value
      • ConditionalSecretCopyRules
        • ConditionalSecretCopyRules
          • ConditionalSecretCopyRules.application
          • ConditionalSecretCopyRules.condition
          • ConditionalSecretCopyRules.key
      • ConditionalSimpleSecretGenerateRules
        • ConditionalSimpleSecretGenerateRules
          • ConditionalSimpleSecretGenerateRules.condition
          • ConditionalSimpleSecretGenerateRules.type
          • ConditionalSimpleSecretGenerateRules.generate()
      • ConditionalSourceSecretGenerateRules
        • ConditionalSourceSecretGenerateRules
          • ConditionalSourceSecretGenerateRules.condition
          • ConditionalSourceSecretGenerateRules.source
          • ConditionalSourceSecretGenerateRules.type
          • ConditionalSourceSecretGenerateRules.generate()
      • PullSecret
        • PullSecret
          • PullSecret.description
          • PullSecret.registries
          • PullSecret.to_dockerconfigjson()
      • RegistryPullSecret
        • RegistryPullSecret
          • RegistryPullSecret.password
          • RegistryPullSecret.username
      • ResolvedSecrets
        • ResolvedSecrets
          • ResolvedSecrets.applications
          • ResolvedSecrets.pull_secret
      • Secret
        • Secret
          • Secret.application
          • Secret.copy_rules
          • Secret.description
          • Secret.generate
          • Secret.key
          • Secret.onepassword
          • Secret.value
      • SecretConfig
        • SecretConfig
          • SecretConfig.copy_rules
          • SecretConfig.description
          • SecretConfig.generate
          • SecretConfig.onepassword
          • SecretConfig.value
      • SecretCopyRules
        • SecretCopyRules
          • SecretCopyRules.application
          • SecretCopyRules.key
      • SecretGenerateType
        • SecretGenerateType
          • SecretGenerateType.bcrypt_password_hash
          • SecretGenerateType.fernet_key
          • SecretGenerateType.gafaelfawr_token
          • SecretGenerateType.mtime
          • SecretGenerateType.password
          • SecretGenerateType.rsa_private_key
      • SecretOnepasswordConfig
        • SecretOnepasswordConfig
          • SecretOnepasswordConfig.encoded
      • SimpleSecretGenerateRules
        • SimpleSecretGenerateRules
          • SimpleSecretGenerateRules.type
          • SimpleSecretGenerateRules.generate()
      • SourceSecretGenerateRules
        • SourceSecretGenerateRules
          • SourceSecretGenerateRules.source
          • SourceSecretGenerateRules.type
          • SourceSecretGenerateRules.generate()
      • StaticSecret
        • StaticSecret
          • StaticSecret.description
          • StaticSecret.value
      • StaticSecrets
        • StaticSecrets
          • StaticSecrets.applications
          • StaticSecrets.pull_secret
          • StaticSecrets.for_application()
    • Variables
      • ConditionalSecretGenerateRules
        • ConditionalSecretGenerateRules
      • SecretGenerateRules
        • SecretGenerateRules
    • Class Inheritance Diagram
  • phalanx.models.vault Module
    • Classes
      • VaultAppRole
        • VaultAppRole
          • VaultAppRole.policies
          • VaultAppRole.role_id
          • VaultAppRole.secret_id
          • VaultAppRole.secret_id_accessor
          • VaultAppRole.to_yaml()
      • VaultAppRoleMetadata
        • VaultAppRoleMetadata
          • VaultAppRoleMetadata.policies
          • VaultAppRoleMetadata.role_id
      • VaultToken
        • VaultToken
          • VaultToken.accessor
          • VaultToken.display_name
          • VaultToken.expires
          • VaultToken.policies
          • VaultToken.token
          • VaultToken.to_yaml()
      • VaultTokenMetadata
        • VaultTokenMetadata
          • VaultTokenMetadata.accessor
          • VaultTokenMetadata.display_name
          • VaultTokenMetadata.expires
          • VaultTokenMetadata.policies
    • Class Inheritance Diagram
  • phalanx.services.application Module
    • Classes
      • ApplicationService
        • ApplicationService
          • ApplicationService.create_application()
    • Class Inheritance Diagram
  • phalanx.services.secrets Module
    • Classes
      • SecretsService
        • SecretsService
          • SecretsService.audit()
          • SecretsService.generate_static_template()
          • SecretsService.get_onepassword_static_secrets()
          • SecretsService.list_secrets()
          • SecretsService.save_vault_secrets()
          • SecretsService.sync()
    • Class Inheritance Diagram
  • phalanx.services.vault Module
    • Classes
      • VaultService
        • VaultService
          • VaultService.audit()
          • VaultService.create_read_approle()
          • VaultService.create_write_token()
    • Class Inheritance Diagram
  • phalanx.storage.config Module
    • Classes
      • ConfigStorage
        • ConfigStorage
          • ConfigStorage.add_application_setting()
          • ConfigStorage.get_application_chart_path()
          • ConfigStorage.get_starter_path()
          • ConfigStorage.load_environment()
          • ConfigStorage.load_environment_config()
          • ConfigStorage.load_phalanx_config()
          • ConfigStorage.write_application_template()
    • Class Inheritance Diagram
  • phalanx.storage.helm Module
    • Classes
      • HelmStorage
        • HelmStorage
          • HelmStorage.create()
    • Class Inheritance Diagram
  • phalanx.storage.onepassword Module
    • Classes
      • OnepasswordClient
        • OnepasswordClient
          • OnepasswordClient.get_secrets()
      • OnepasswordStorage
        • OnepasswordStorage
          • OnepasswordStorage.get_onepassword_client()
    • Class Inheritance Diagram
  • phalanx.storage.vault Module
    • Classes
      • VaultClient
        • VaultClient
          • VaultClient.create_approle()
          • VaultClient.create_policy()
          • VaultClient.create_token()
          • VaultClient.delete_application_secret()
          • VaultClient.get_application_secret()
          • VaultClient.get_approle()
          • VaultClient.get_environment_secrets()
          • VaultClient.get_policy()
          • VaultClient.get_token()
          • VaultClient.list_application_secrets()
          • VaultClient.list_token_accessors()
          • VaultClient.revoke_approle_secret_ids()
          • VaultClient.revoke_token()
          • VaultClient.store_application_secret()
          • VaultClient.update_application_secret()
      • VaultStorage
        • VaultStorage
          • VaultStorage.get_vault_client()
    • Class Inheritance Diagram
  • phalanx.yaml Module
    • Classes
      • YAMLFoldedString
        • YAMLFoldedString
    • Class Inheritance Diagram