Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Deployment documentation migration - definitions #1073

Closed
wants to merge 4 commits into from
Closed

[doc] Deployment documentation migration - definitions #1073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51a83c3
[doc] Deployment documentation migration - terminology notes
barroco Aug 21, 2024
181d64b
Add pooling
barroco Aug 21, 2024
fde7f0d
Adapt structure
barroco Aug 21, 2024
29f8c46
format
barroco Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions build/pooling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,7 @@ F3411-19 A2.6.2).

### Terminology notes

CockroachDB (CRDB) establishes a distributed data store called a "cluster".
This cluster stores the DSS Airspace Representation (DAR) in multiple SQL
databases within that cluster. This cluster is composed of many CRDB nodes,
potentially hosted by multiple organizations.

Kubernetes manages a set of services in a "cluster". This is an entirely
different thing from the CRDB data store, and this type of cluster is what the
deployment instructions refer to. A Kubernetes cluster contains one or more
node pools: collections of machines available to run jobs. This node pool is an
entirely different thing from a DSS pool.
The content of this section has been migrated to [Definitions and terminology notes](../deploy/architecture.md#definitions-and-terminology-notes).

## Objective

Expand Down
47 changes: 43 additions & 4 deletions deploy/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,52 @@

See [introduction](../build/pooling.md#introduction)

## Architecture
## Definitions and terminology notes

See [architecture](../build/deploy/README.md#architecture)
This section defines some concepts and related references used in this documentation.

### DSS Region

A DSS Region is a region in which a single, unified airspace representation is
presented by one or more interoperable DSS instances, each instance typically
operated by a separate organization. A specific environment (for example,
"production" or "staging") in a particular DSS Region is called a "pool".

### DSS Pool

A DSS Pool is a set of interoperable and interconnected DSS instances in a specific
DSS Region. Each instance is typically operated by a separate organization.

### DSS instance

A DSS instance is a single logical replica in a DSS pool hosted by a single
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this 'single logical replica' be on several CRDB nodes? I.e. can a DSS instance host several CRDB nodes?

organization.

### Terminology notes
### Pooling

See [teminology notes](../build/pooling.md#terminology-notes).
The process required by a DSS Instance to join a DSS Pool is referred to "Pooling"
in this documentation.

### CRDB cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Add 'CRDB node'?
  • What's the relationship between CRDB cluster/node and DSS instance/pool?


CockroachDB (CRDB) establishes a distributed data store called a "cluster".
This cluster stores the DSS Airspace Representation (DAR) in multiple SQL
databases within that cluster. This cluster is composed of many CRDB nodes,
potentially hosted by multiple organizations.
"CRDB cluster" is used to refer to this concept in this documentation.

### Kubernetes cluster

Kubernetes manages a set of services in a "cluster". This is an entirely
different thing from the CRDB data store, and this type of cluster is what the
deployment instructions refer to. A Kubernetes cluster contains one or more
node pools: collections of machines available to run jobs. This node pool is an
entirely different thing from a DSS pool.
Comment on lines +43 to +47
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are those clarifications really needed?

"Kubernetes cluster" is used to refer to this concept in this documentation.

## Architecture

See [architecture](../build/deploy/README.md#architecture)

## Pooling

Expand Down
Loading