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
- 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
- Classes
- Application
ApplicationApplication.active_environmentsApplication.chartApplication.doc_linksApplication.environment_secretsApplication.environment_valuesApplication.nameApplication.namespaceApplication.projectApplication.secretsApplication.valuesApplication.homepageApplication.model_computed_fieldsApplication.source_urls
- ApplicationConfig
ApplicationConfigApplicationConfig.chartApplicationConfig.doc_linksApplicationConfig.environment_secretsApplicationConfig.environment_valuesApplicationConfig.nameApplicationConfig.namespaceApplicationConfig.projectApplicationConfig.secretsApplicationConfig.valuesApplicationConfig.homepageApplicationConfig.model_computed_fieldsApplicationConfig.source_urls
- ApplicationInstance
- DocLink
- Project
- Application
- Class Inheritance Diagram
- Classes
- phalanx.models.environments Module
- Classes
- ControlSystemConfig
ControlSystemConfigControlSystemConfig.app_namespaceControlSystemConfig.image_tagControlSystemConfig.kafka_broker_addressControlSystemConfig.kafka_topic_replication_factorControlSystemConfig.s3_endpoint_urlControlSystemConfig.schema_registry_urlControlSystemConfig.site_tagControlSystemConfig.topic_nameControlSystemConfig.model_dump()ControlSystemConfig.model_dump_json()ControlSystemConfig.model_computed_fields
- Environment
EnvironmentEnvironment.applicationsEnvironment.butler_repository_indexEnvironment.butler_server_repositoriesEnvironment.control_systemEnvironment.fqdnEnvironment.gcpEnvironment.nameEnvironment.onepasswordEnvironment.vault_path_prefixEnvironment.vault_urlEnvironment.all_applications()Environment.all_secrets()Environment.model_dump()Environment.model_dump_json()Environment.model_computed_fieldsEnvironment.vault_pathEnvironment.vault_read_approleEnvironment.vault_read_policyEnvironment.vault_write_policyEnvironment.vault_write_token
- EnvironmentBaseConfig
EnvironmentBaseConfigEnvironmentBaseConfig.butler_repository_indexEnvironmentBaseConfig.butler_server_repositoriesEnvironmentBaseConfig.control_systemEnvironmentBaseConfig.fqdnEnvironmentBaseConfig.gcpEnvironmentBaseConfig.nameEnvironmentBaseConfig.onepasswordEnvironmentBaseConfig.vault_path_prefixEnvironmentBaseConfig.vault_urlEnvironmentBaseConfig.model_dump()EnvironmentBaseConfig.model_dump_json()EnvironmentBaseConfig.model_computed_fieldsEnvironmentBaseConfig.vault_pathEnvironmentBaseConfig.vault_read_approleEnvironmentBaseConfig.vault_read_policyEnvironmentBaseConfig.vault_write_policyEnvironmentBaseConfig.vault_write_token
- EnvironmentConfig
EnvironmentConfigEnvironmentConfig.applicationsEnvironmentConfig.butler_repository_indexEnvironmentConfig.butler_server_repositoriesEnvironmentConfig.control_systemEnvironmentConfig.fqdnEnvironmentConfig.gcpEnvironmentConfig.nameEnvironmentConfig.onepasswordEnvironmentConfig.repo_urlEnvironmentConfig.target_revisionEnvironmentConfig.vault_path_prefixEnvironmentConfig.vault_urlEnvironmentConfig.model_dump()EnvironmentConfig.model_dump_json()EnvironmentConfig.enabled_applicationsEnvironmentConfig.model_computed_fieldsEnvironmentConfig.vault_pathEnvironmentConfig.vault_read_approleEnvironmentConfig.vault_read_policyEnvironmentConfig.vault_write_policyEnvironmentConfig.vault_write_token
- EnvironmentDetails
EnvironmentDetailsEnvironmentDetails.applicationsEnvironmentDetails.argocd_rbacEnvironmentDetails.argocd_urlEnvironmentDetails.butler_repository_indexEnvironmentDetails.butler_server_repositoriesEnvironmentDetails.control_systemEnvironmentDetails.fqdnEnvironmentDetails.gafaelfawr_scopesEnvironmentDetails.gcpEnvironmentDetails.identity_providerEnvironmentDetails.nameEnvironmentDetails.onepasswordEnvironmentDetails.vault_path_prefixEnvironmentDetails.vault_urlEnvironmentDetails.model_dump()EnvironmentDetails.model_dump_json()EnvironmentDetails.model_computed_fieldsEnvironmentDetails.vault_pathEnvironmentDetails.vault_read_approleEnvironmentDetails.vault_read_policyEnvironmentDetails.vault_write_policyEnvironmentDetails.vault_write_token
- GCPMetadata
- GafaelfawrGitHubGroup
- GafaelfawrGitHubTeam
- GafaelfawrScope
- IdentityProvider
- OnepasswordConfig
- PhalanxConfig
- ControlSystemConfig
- 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
ConfigStorageConfigStorage.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.update_shared_chart_version()ConfigStorage.write_application_template()
- ConfigStorage
- Class Inheritance Diagram
- Classes
- phalanx.storage.helm Module
- phalanx.storage.onepassword Module
- phalanx.storage.vault Module
- Classes
- VaultClient
VaultClientVaultClient.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