Glossary
Confidentiality:
Intro
- Terms and abbreviations commonly used at Giant Swarm.
- Where we care, the exact capitalization is mentioned.
- If something is missing please open a pull request. 🙏
- Roles and job titles are documented over at Roles & Habits @ Giant Swarm
- Your future colleagues and future self will thank you. ❤️
A
Ambassador
Someone who is responsible for the information flow between your team and a certain SIG (both directions). See Ambassadors for SIGs.
Area
A combination of multiple teams e.g. the “Kubernetes as a Service” (KaaS) Area.
Architecture decision record (ADR)
A document which records architectural decisions and its consequences.
App
The term app could refer to (1) the concept of apps in general (e.g. kong, redis, etc.) or (2) an entry in an App Catalog.
We do not differentiate between app vs App, as it easy to make a capitalization mistake when typing. We also do not use applications in the context of Managed Services or Managed Apps.
See also: Managed App
App Catalog
an App Catalog can refer to a specific catalog, i.e. the “Giant Swarm Catalog” or “Control Plane Catalog”.
App Platform
In contrast to Managed Apps, App Platform is the tooling (i.e. app-operator and chart-operator) that enables the creation and maintenance of Apps.
B
Bring your own cloud (BYOC)
Deprecated. The former name associated with the multi-account support functionality.
C
Customer config repository (CCR)
Customer repository for holding customer and management cluster specific app configurations. Builds on giantswarm/shared-configs.
Repository name must follow the naming convention: <CUSTOMER_NAME>-configs, e.g: giantswarm-configs.
Chapter
A group of people with the same role (possibly limited by Area) like PEs of SaaS Area, POs, SAs, Recruiters, Sales.
Client certificate
X.509 certificate used by a client to authenticate with a server. In the Giant Swarm context, client certificates are a common authentication means (but not the only one) for the Kubernetes API. For example, we provide tooling to help end users create client certificates to access their workload clusters.
Formerly called key pair, since the client needs both a private key and the certificate (public key) to authenticate. We switched to the term client certificate to align with the terminology used by the Kubernetes project.
Cluster API
From the book: “Cluster API is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.”. In other words: Cluster API enables Kubernetes to manage Kubernetes clusters.
Internally Cluster API is also abbreviated as CAPI. In our written communication, please avoid the abbreviation and always use the full spelling in title case.
Do not use:
- CAPI
- cluster API
- ClusterAPI
Customer management clusters (CMC)
Customer repository for holding the actual MC gitops repository, containing the customer MCs. Builds on MCB by using Flux remote bases.
Repository name must follow the naming convention: <CUSTOMER_NAME>-management-clusters, e.g: giantswarm-management-clusters.
D
E
End to end (E2E) test
An automated test for an application flow from start to end. To simulate real user scenarios and validate the system under test.
For Giant Swarm an example is running the Kubernetes conformance tests against a workload cluster. Whereas an integration test only tests a single component within the Giant Swarm release.
Ephemeral Management Cluster (Ephemeral MC)
A short-lived Management Cluster that is used for testing the creation of management clusters. An Ephermaral Management Cluster is created, destroyed and recreated to test the full lifecycle of MCs and is usually managed via automated testing. The same name and configuration is used for each test run.
It is expected that an Ephemeral Management Cluster isn’t always available and ideally should only exist while it is being actively tested.
These clusters should have all alerts silenced.
F
G
H
High-availability control plane
A feature of our product indicating that workload clusters are provisioned with three control plane nodes instead of one. See our public docs for details.
High-availability Kubernetes masters
Deprecated, former name for high-availability control plane.
I
Identity provider (IdP)
“A system entity that creates, maintains, and manages identity information for principals while providing authentication services to relying applications within a federation or distributed network.” Our SSO uses Azure AD and GitHub as our identity providers.
Installation
The overall environment managed for a customer used as a landing zone by Giant Swarm to install the needed infrastructure to run your workloads. Includes eventual Cloud Provider specific accounts.
Integration test
An integration test tests an individual component to expose defects in that component or how it interacts with other components.
For Giant Swarm an example is a test for an operator which runs in a KIND cluster in Circle CI. It differs from an end-to-end test which tests an entire Giant Swarm release.
J
K
Key pair
Now called client certificate.
KIND
Kubernetes in Docker is an upstream tool for running local Kubernetes clusters using Docker container “nodes”. See official docs for more information.
L
Legacy
A legacy release is any release made prior to Cluster API. You can find all legacy releases in our release repository. Check Vintage product to know more why is still relevant.
M
Managed App
A Managed App is an app we actively manage for customers, i.e. the apps in the Giant Swarm Catalog (Ingress NGINX Controller, Kong, EFK, etc.).
Managed Apps is also shorthand for the “Managed Apps Area,” which comprise of the members of Team Batman and Team Halo.
These are NOT Managed Apps
- Apps in the Playground Catalog are Playground Apps. They are not managed, but are “supported with best-effort.” See: Giant Swarm Management and Support Description for more.
- app-operator and chart-operator. They collectively make up the App Platform.
Management cluster (MC)
A Kubernetes cluster running Giant Swarm specific management components essential for the installation.
Formerly called “control plane”, often abbreviated as “CP”.
Some types of Management Clusters: Ephemeral Management Clusters, Stable-testing Management Clusters
Management clusters fleet (MCF)
Legacy gitOps configuration for management clusters. Initially, we kept it all in one repo named management-clusters-fleet. Later we split this up for security/permission reasons.
See: MCB, CMC
Management cluster bases (MCB)
Manifests management clusters are built on and shared between multiple MCs / customers, for example provider bases (aws,capa,capz,gcp,etc.), our flux setup and optional extra components like external-secrets, crossplane, etc.
Located at: https://github.com/giantswarm/management-cluster-bases
Management cluster initializer (MCI)
The AWS CloudFormation Stack created for each workload cluster where we manage VPC Peering Connections.
Management API
The Kubernetes API of the management cluster.
Internally this is also often abbreviated as MAPI, however we don’t use that abbrevation in external communication.
Spelling: Always spelled Management API with an uppercase M.
Multi-account support
The ability for a management cluster to manage accounts and launch workload clusters outside its default accounts. The functionality formerly known as Bring Your Own Cloud (BYOC).
N
O
P
Postmortem
A Postmortem is a specialized workflow, typically towards resolving operational issues. See our docs. Often abbreviated as “PM”.
Post deploy verification (PDV)
Is a column in most of our GitHub project boards. When an issue is closed the automation moves it to this column. This gives us the chance to check that changes are documented and communicated (internally and / or externally, whatever applies) before archiving the issue.
Platform Engineer (PE)
A backend developer at Giant Swarm that works mainly on automation within our product. SIG Operator is the SIG of Platform Engineers.
Q
R
Rockefeller Habits
A framework for business growth.
See this introduction.
S
Single sign-on (SSO)
The concept of using one identity to authenticate with different services. E. g. using a Google account to authenticate for a Software as a Service (SaaS) like LastPass.
Special interest group (SIG)
SIGs are a long term concept where people interested in a certain topic or stakeholders in the topic meet regularly. The goal of the SIG is to continuously find alignment and a shared vision of the topic across the company (represented by the people that join).
Therefore ideas, implementation plans or questions can be brought to a SIG for alignment, reflection and advice. Each SIG has a driver who acts as a facilitator for the SIGs meetings and rituals.
For more information, please refer to this blog post
Special working hours (SWH)
Time allocated for specific SIG work. Usually one hour bi-weekly. People get together and work on what they are interested in, within the scope of the particular SIG.
Stable-Testing Management Clusters (Stable-Testing MC)
A test management cluster that is specifically selected for automated end-to-end testing. These management clusters are used by end-to-end tests to create new test workload clusters that have a suite of tests run against them and are then removed.
Stable-testing management clusters shouldn’t be used for testing of applications deployed onto MCs and should be treated like production clusters in almost all regards except that these clusters are configured to page only during working hours (and not to page for their test workload clusters).
T
U
Unit test
A Unit Test is an automated test that tests a section of application code. It differs from an Integration Test because it only tests part of the code and should not make network calls to external systems.
At Giant Swarm we focus unit tests on complex or error prone code rather than targeting overall coverage. See giantswarm/fmt for more details.
V
Vintage product
This is the previous generation of our product and is still in production with many of our customers. We still actively support this generation. However, the development focus is limited to main customer needs and supporting the migration to our CLuster API-based implementations.
W
Working group (WG)
WGs are a short term concept where people willing to work on a specific task (across different teams) meet.
A WG therefor has a narrowly defined, actionable goal statement which it can realistically achieve with the number of people participating. It dissolves itself once the members of a WG have achieved that goal in their own perception.
Check this blog post for more information.
Workload cluster (WC)
A Kubernetes cluster running customer specific workloads. It is managed by some management cluster.
Formerly called
- “tenant cluster”, often abbreviated as “TC”
- “guest cluster”
Workload cluster release
The software stack comprising a workload cluster.