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.
- JSON schema
- Phalanx internal API
- phalanx Package
- phalanx.constants Module
- phalanx.docs.crossref Module
- phalanx.docs.jinja Module
- phalanx.exceptions Module
- Classes
- ApplicationExistsError
- HelmFailedError
- InvalidApplicationConfigError
- InvalidEnvironmentConfigError
- InvalidSecretConfigError
- MalformedOnepasswordSecretError
- MissingOnepasswordSecretsError
- NoOnepasswordConfigError
- NoOnepasswordCredentialsError
- UnknownEnvironmentError
- UnresolvedSecretsError
- VaultNotFoundError
- Class Inheritance Diagram
- Classes
- phalanx.factory Module
- phalanx.models.applications Module
- phalanx.models.environments Module
- Classes
- Environment
Environment
Environment.applications
Environment.butler_repository_index
Environment.fqdn
Environment.name
Environment.onepassword
Environment.vault_path_prefix
Environment.vault_url
Environment.all_applications()
Environment.all_secrets()
Environment.model_dump()
Environment.model_dump_json()
Environment.vault_path
Environment.vault_read_approle
Environment.vault_read_policy
Environment.vault_write_policy
Environment.vault_write_token
- EnvironmentBaseConfig
EnvironmentBaseConfig
EnvironmentBaseConfig.butler_repository_index
EnvironmentBaseConfig.fqdn
EnvironmentBaseConfig.name
EnvironmentBaseConfig.onepassword
EnvironmentBaseConfig.vault_path_prefix
EnvironmentBaseConfig.vault_url
EnvironmentBaseConfig.model_dump()
EnvironmentBaseConfig.model_dump_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.repo_url
EnvironmentConfig.target_revision
EnvironmentConfig.vault_path_prefix
EnvironmentConfig.vault_url
EnvironmentConfig.model_dump()
EnvironmentConfig.model_dump_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.butler_repository_index
EnvironmentDetails.fqdn
EnvironmentDetails.gafaelfawr_scopes
EnvironmentDetails.identity_provider
EnvironmentDetails.name
EnvironmentDetails.onepassword
EnvironmentDetails.vault_path_prefix
EnvironmentDetails.vault_url
EnvironmentDetails.model_dump()
EnvironmentDetails.model_dump_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
- GafaelfawrGitHubTeam
- GafaelfawrScope
- IdentityProvider
- OnepasswordConfig
- PhalanxConfig
- Environment
- Class Inheritance Diagram
- Classes
- phalanx.models.gafaelfawr Module
- phalanx.models.helm Module
- phalanx.models.secrets Module
- Classes
- ConditionalMixin
- ConditionalSecretConfig
- ConditionalSecretCopyRules
- ConditionalSimpleSecretGenerateRules
- ConditionalSourceSecretGenerateRules
- PullSecret
- RegistryPullSecret
- ResolvedSecrets
- Secret
- SecretConfig
- SecretCopyRules
- SecretGenerateType
- SecretOnepasswordConfig
- SimpleSecretGenerateRules
- SourceSecretGenerateRules
- StaticSecret
- StaticSecrets
- Variables
- Class Inheritance Diagram
- Classes
- phalanx.models.vault Module
- phalanx.services.application Module
- phalanx.services.environment Module
- phalanx.services.secrets Module
- phalanx.services.vault Module
- phalanx.storage.config Module
- Classes
- ConfigStorage
ConfigStorage
ConfigStorage.add_application_setting()
ConfigStorage.get_all_dependency_repositories()
ConfigStorage.get_application_chart_path()
ConfigStorage.get_application_environments()
ConfigStorage.get_dependency_repositories()
ConfigStorage.get_environment_chart_path()
ConfigStorage.get_modified_applications()
ConfigStorage.get_starter_path()
ConfigStorage.list_application_environments()
ConfigStorage.list_applications()
ConfigStorage.list_environments()
ConfigStorage.load_environment()
ConfigStorage.load_environment_config()
ConfigStorage.load_phalanx_config()
ConfigStorage.write_application_template()
- ConfigStorage
- Class Inheritance Diagram
- Classes
- phalanx.storage.helm Module
- phalanx.storage.onepassword Module
- 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
- VaultClient
- Class Inheritance Diagram
- Classes
- phalanx.yaml Module