1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
---
stage: Enablement
group: Geo
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: howto
---
# Geo Glossary
NOTE:
We are updating the Geo documentation, user interface and commands to reflect these changes. Not all pages comply with
these definitions yet.
These are the defined terms to describe all aspects of Geo. Using a set of clearly
defined terms helps us to communicate efficiently and avoids confusion. The language
on this page aims to be [ubiquitous](https://about.gitlab.com/handbook/communication/#ubiquitous-language)
and [as simple as possible](https://about.gitlab.com/handbook/communication/#simple-language).
We provide example diagrams and statements to demonstrate correct usage of terms.
| Term | Definition | Scope | Discouraged synonyms |
|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-------------------------------------------------|
| Node | An individual server that runs GitLab either with a specific role or as a whole (e.g. a Rails application node). In a cloud context this can be a specific machine type. | GitLab | instance, server |
| Site | One or a collection of nodes running a single GitLab application. A site can be single-node or multi-node. | GitLab | deployment, installation instance |
| Single-node site | A specific configuration of GitLab that uses exactly one node. | GitLab | single-server, single-instance
| Multi-node site | A specific configuration of GitLab that uses more than one node. | GitLab | multi-server, multi-instance, high availability |
| Primary site | A GitLab site that is configured to be read and writable. There can only be a single primary site. | Geo-specific | Geo deployment, Primary node |
| Secondary site(s) | GitLab site that is configured to be read-only. There can be one or more secondary sites. | Geo-specific | Geo deployment, Secondary node |
| Geo deployment | A collection of two or more GitLab sites with exactly one primary site being replicated by one or more secondary sites. | Geo-specific | |
| Reference architecture(s) | A [specified configuration of GitLab for a number of users](../reference_architectures/index.md), possibly including multiple nodes and multiple sites. | GitLab | |
| Promoting | Changing the role of a site from secondary to primary. | Geo-specific | |
| Demoting | Changing the role of a site from primary to secondary. | Geo-specific | |
| Failover | The entire process that shifts users from a primary Site to a secondary site. This includes promoting a secondary, but contains other parts as well e.g. scheduling maintenance. | Geo-specific | |
## Examples
### Single-node site
```mermaid
graph TD
subgraph S-Site[Single-node site]
Node_3[GitLab node]
end
```
### Multi-node site
```mermaid
graph TD
subgraph MN-Site[Multi-node site]
Node_1[Application node]
Node_2[Database node]
Node_3[Gitaly node]
end
```
### Geo deployment - Single-node sites
This Geo deployment has a single-node primary site, a single-node secondary site:
```mermaid
graph TD
subgraph Geo deployment
subgraph Primary[Primary site, single-node]
Node_1[GitLab node]
end
subgraph Secondary1[Secondary site 1, single-node]
Node_2[GitLab node]
end
end
```
### Geo deployment - Multi-node sites
This Geo deployment has a multi-node primary site, a multi-node secondary site:
```mermaid
graph TD
subgraph Geo deployment
subgraph Primary[Primary site, multi-node]
Node_1[Application node]
Node_2[Database node]
end
subgraph Secondary1[Secondary site 1, multi-node]
Node_5[Application node]
Node_6[Database node]
end
end
```
### Geo deployment - Mixed sites
This Geo deployment has a multi-node primary site, a multi-node secondary site and another single-node secondary site:
```mermaid
graph TD
subgraph Geo deployment
subgraph Primary[Primary site, multi-node]
Node_1[Application node]
Node_2[Database node]
Node_3[Gitaly node]
end
subgraph Secondary1[Secondary site 1, multi-node]
Node_5[Application node]
Node_6[Database node]
end
subgraph Secondary2[Secondary site 2, single-node]
Node_7[Single GitLab node]
end
end
```
|
