Version: Weekly Build
Glossary
Terms
| Term | Definition |
|---|---|
| Jumpbox | The single machine with a public IP and SSH access used to administer the installation; see Provision the hosts. |
| OMS | The Codesphere CLI administrators use to download packages, generate the install configuration, and run the installer. |
| Portal | The Codesphere package portal OMS downloads installer packages from, authenticated with OMS_PORTAL_API_KEY. |
Install config (config.yaml) | The file describing infrastructure, network, storage, registry, domains, authentication, plans, and enabled features; see Private cloud installer config reference. |
Vault (prod.vault.yaml) | The file holding generated passwords, private keys, certificates, and provider credentials, encrypted with SOPS; see Private cloud installer vault secrets. |
| Age key | The age identity used to encrypt and decrypt the vault with SOPS. |
| SOPS | SOPS (Secrets OPerationS), the tool used to encrypt the vault at rest. |
| Installer package | The .tar.gz artifact downloaded from the portal (oms download package) that OMS runs against your install configuration. |
| Data center | The dataCenter block in config.yaml (an ID, name, city, and country code) identifying this installation, not a physical building. |
| Profile | An oms init install-config --profile value (dev, minimal, or prod/production) that sets defaults for monitoring and resource requests; see Install steps and profiles. |
noRequests | The resource profile applied by the dev and minimal profiles that removes CPU/memory requests so a smaller cluster can schedule the platform; see Install steps and profiles. |
| Skip step | A named installer step (for example load-container-images) that can be bypassed with --skip-steps or operations.skip; see Install steps and profiles. |
| Gateway / public gateway | The two Kubernetes services exposing Codesphere: the platform gateway (gateway-controller) and the workspace gateway (public-gateway-controller); see Architecture. |
| Hosting plan | A raw resource allocation (codesphere.plans.hostingPlans: CPU, memory, storage) referenced by one or more workspace plans; see Workspace and hosting plans. |
| Workspace plan | A user-selectable plan (codesphere.plans.workspacePlans) that maps to a hosting plan and sets replica and on-demand behavior. |
| Managed service | A backend (for example PostgreSQL or S3) offered to developers through Codesphere's Managed Services feature, configured under codesphere.managedServices; see Managed services. |
| Workspace | A developer's running development environment, hosted in the workspaces namespace. |
| BOM (bill of materials) | The manifest bundled in the installer package listing the container image versions and files that make up a given Codesphere release. |
| pc-apps | The Argo CD "pc-applications" chart the installer deploys, which manages additional cluster components (such as ssh-workspace-proxy) as Argo CD Applications; see Architecture. |