Add project glossary. (#262)

This glossary is not meant to be complete, as
no glossary can be.  It does mean to cover the
basic different deployments.

To keep things clear, federation was also added
to clarify that federation is not a deployment
but a different "thing".

Closes #261

---------

Signed-off-by: Edwin Buck <[email protected]>
Co-authored-by: Marco Franssen <[email protected]>
Co-authored-by: kfox1111 <[email protected]>
This commit is contained in:
Edwin Buck
2023-05-10 12:53:17 -07:00
committed by GitHub
co-authored by Marco Franssen kfox1111
parent c4656a74b2
commit 73435be9a1
2 changed files with 54 additions and 0 deletions
+46
View File
@@ -0,0 +1,46 @@
<!-- vim: ft=markdown colorcolumn=72
-->
# Glossary
This glossary is a dictionary of terms defined as they are used by the
spire/helm-charts project. Writing the definitions of terms here helps
to keep other documents concise and precise. Documenting terminology
here helps prevent misundersandings, facilitating easy onboarding of new
team members.
**Deployment**
: A use of the Helm Charts to describe a single SPIRE cluster.
**Deployment Type**
: One of three supported deployments of the charts: Standalone,
Primary, or Secondary.
**Federation**
: When one cluster is configured to trust elements of another cluster
containing a different trust domain.
**Federated Deployment**
: A Primary Deployment or Standalone Deployment that is configured
to federate with one or more Deployments.
**Primary Deployment**
: A deployment of the Helm Charts where the cluster's purpose is to
provide certificates to Secondary Deployments.
**Secondary Deployment**
: A deployment of the Helm Charts where the cluster obtains an
intermediate CA from a Primary Deployment and uses it to service
Workload Identity requests.
**Standalone Deployment**
: A deployment of the Helm Charts where the cluster both manages the CA
and services Workload Identity requests in the same cluster.
**Tiered Deployment**
: Use of the Helm Charts two or more times, such that one chart is
configured as a Primary Deployment Type and the others are configured as
Secondary Deployment Types.
**Trust Domain**
: The host field of a SPIFFE ID, naming a minimum footprint of a trust
bundle's distribution.
+8
View File
@@ -41,3 +41,11 @@ within the primary github repository.
The project is currently in a pre-release status. While the standalone The project is currently in a pre-release status. While the standalone
deployment is close to release quality, the tiered deployment is not. deployment is close to release quality, the tiered deployment is not.
## Project Navigation
Below are links to project documentation useful for the management and
maintenance of the spire/helm project.
### Coordination
- [glossary](glossary.md)