UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects

Update docs/guides/using-bigbang/style.md,...

Merged Caitlin Bowman-Clare requested to merge cmbc_19july into master
4 files
+ 31
30
Compare changes
  • Side-by-side
  • Inline
Files
4
# General Conventions Style Guide
This style guide outlines the general conventions to follow for package names, structure standardization, version numbers, and YAML formatting focusing on the Big Bang Helm chart. Individual packages (core, addons, community) may not follow these exact standards.
This style guide outlines the general conventions to follow for package names, structure standardization, version numbers, and YAML formatting focusing on the Big Bang Helm chart. Individual packages (e.g., core, addons, community) may not follow these exact standards.
## Package Names
When creating package names, consider that different usages of the name will require different formats. For Helm values keys use camelCase to delineate multi-word package names. Avoid using . or - within values keys to simplify Helm templating. Kubernetes resources require translation to kebab-case as they do not support uppercase. Package naming for Kubernetes resources should be consistent across all resources (GitRepository, Namespace, HelmRelease, labels, etc).
When creating package names, consider that different usages of the name will require different formats. For Helm values keys use camelCase to delineate multi-word package names. Avoid using . or - within values keys to simplify Helm templating. Kubernetes resources require translation to kebab-case as they do not support uppercase. Package naming for Kubernetes resources should be consistent across all resources (e.g., GitRepository, Namespace, HelmRelease, and/or labels).
##### Notable Exceptions
> If a package name is two words and the additional words are less than four characters, consider it as part of the single name. Examples include "fluentbit" (technically "Fluent Bit") and "argocd" (technically "Argo CD").
@@ -12,17 +12,17 @@ When creating package names, consider that different usages of the name will req
## Formatting YAML
When formatting YAML files, follow these guidelines:
- Indent using two spaces, not tabs.
- Use camelCase and alphanumeric keys, without any special characters.
- Ensure that all Kubernetes resource names, repository names, and namespaces are lowercase, alphanumeric, or hyphenated, using kebab-case.
* Indent using two spaces, not tabs.
* Use camelCase and alphanumeric keys, without any special characters.
* Ensure that all Kubernetes resource names, repository names, and namespaces are lowercase, alphanumeric, or hyphenated, using kebab-case.
## Structure Standardization
For each package, ensure that the following items have the same name:
- Folder: chart/templates/<package\>
- Top-level key: chart/templates/values.yaml
- Namespace: chart/templates/<package\>/namespace.yaml, unless targeting another package's namespace.
- Repo name: https://repo1.dso.mil/bigbang/packages/<package\>
* Folder: chart/templates/<package\>
* Top-level key: chart/templates/values.yaml
* Namespace: chart/templates/<package\>/namespace.yaml, unless targeting another package's namespace.
* Repo name: https://repo1.dso.mil/bigbang/packages/<package\>
##
Loading