Skip to content

Commit 9ecceb5

Browse files
sandersonjstirnaman
sanderson
and
jstirnaman
authored
Reorganize InfluxDB Clustered installation documentation (#5636)
* WIP clustered install restructure * WIP clustered install restructure * WIP clustered install reorg * finalize clustered install reorg for preview * updates to address PR feedback * added garbage collector scaling config * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * removed obsolete api artifacts * remove callouts for specific dependency versions * Clustered sizing recommendations per vendor (#5652) * added vendor-specific sizing recommendations to clustered * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * remove medium-sized workload link --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent 15ee141 commit 9ecceb5

File tree

38 files changed

+4056
-2146
lines changed

38 files changed

+4056
-2146
lines changed

‎assets/styles/layouts/article/_buttons.scss

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ a.btn {
4848
font-size: 1.1rem;
4949
}
5050

51+
&.arrow span.CaretOutlineRight {
52+
font-size: 1.5rem;
53+
line-height: 0;
54+
vertical-align: sub;
55+
display: inline-block;
56+
margin-right: -.65rem;
57+
}
58+
5159
&.small-plus {
5260
padding: .25em;
5361
line-height: .65rem;

‎assets/styles/layouts/article/_captions.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
code { font-size: .9rem; }
1212
}
1313

14-
p, li {
14+
p, li, ol, ul {
1515
& + .caption {
1616
padding: 0;
1717
margin: -.75rem 0 0;

‎assets/styles/layouts/article/_code.scss

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ span.code-callout, .code-placeholder {
8484
&.green {color: $article-code-accent3;}
8585
&.magenta {color: $br-new-magenta;}
8686
&.orange {color: $r-curacao;}
87+
&.delete, &.strike {text-decoration: line-through;}
8788
}
8889

8990
/////////////// Styles for code placeholders that can be updated ///////////////
@@ -157,7 +158,7 @@ span.code-callout, .code-placeholder {
157158
}
158159
}
159160
}
160-
.code-placeholder-key code {color: $code-placeholder}
161+
.code-placeholder-key code {color: $code-placeholder !important}
161162

162163

163164
////////////////////////////////////////////////////////////////////////////////

‎assets/styles/layouts/article/_title.scss

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@
1010

1111
li {
1212
margin-bottom: 0;
13-
padding: 0 .65em 0 .75em;
13+
padding: .45em .75em;
1414
color: $article-heading;
1515
background: rgba($article-heading, .07);
1616
font-size: .95rem;
1717
font-weight: $medium;
18-
border-radius: 1em;
18+
line-height: 1.1rem;
19+
border-radius: 1.1em;
1920
display: inline-block;
2021

2122
&.updated-in,

‎content/influxdb/clustered/admin/bypass-identity-provider.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,6 @@ In the examples above, replace the following:
101101
The name of your InfluxDB namespace.
102102
- {{% code-placeholder-key %}}`KEY_GEN_JOB`{{% /code-placeholder-key %}}:
103103
The name of the key-gen job pod.
104-
- {{% code-placeholder-key %}}`001`{{% /code-placeholder-key %}}:
105-
A unique number used to increment the key-gen job.
106104
107105
{{% note %}}
108106
To create a new admin token after revoking the existing one, rerun the

‎content/influxdb/clustered/admin/env-vars.md

Lines changed: 176 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,22 @@ potential unintended consequences.
3232
## AppInstance component schema
3333

3434
In your `AppInstance` resource, configure individual component settings in the
35-
`spec.package.spec.components` property. This property supports the following
36-
InfluxDB Clustered component keys:
35+
`spec.package.spec.components` property if configuring your `AppInstance` resource
36+
directly or, if using Helm, use the `components` property in your `values.yaml`.
37+
This property supports the following InfluxDB Clustered component keys:
3738

3839
- `ingester`
3940
- `querier`
4041
- `router`
4142
- `compactor`
4243
- `garbage-collector`
4344

45+
{{< code-tabs-wrapper >}}
46+
{{% code-tabs %}}
47+
[AppInstance](#)
48+
[Helm](#)
49+
{{% /code-tabs %}}
50+
{{% code-tab-content %}}
4451
```yaml
4552
apiVersion: kubecfg.dev/v1alpha1
4653
kind: AppInstance
@@ -63,6 +70,24 @@ spec:
6370
garbage-collector:
6471
# Garbage collector settings ...
6572
```
73+
{{% /code-tab-content %}}
74+
{{% code-tab-content %}}
75+
```yaml
76+
# ...
77+
components:
78+
ingester:
79+
# Ingester settings ...
80+
querier:
81+
# Querier settings ...
82+
router:
83+
# Router settings. ...
84+
compactor:
85+
# Compactor settings ...
86+
garbage-collector:
87+
# Garbage collector settings ...
88+
```
89+
{{% /code-tab-content %}}
90+
{{< /code-tabs-wrapper >}}
6691

6792
_For more information about components in the InfluxDB v3 storage engine, see
6893
the [InfluxDB v3 storage engine architecture](/influxdb/clustered/reference/internals/storage-engine/)._
@@ -72,39 +97,81 @@ the [InfluxDB v3 storage engine architecture](/influxdb/clustered/reference/inte
7297
1. Under the specific component property, use the
7398
`<component>.template.containers.iox.env` property to define environment
7499
variables.
75-
2. In the `env` property, structure each environment variable as a key-value pair.
100+
2. In the `env` property, structure each environment variable as a key-value
101+
pair where the key is the environment variable name and the value is the
102+
environment variable value (string-formatted).
76103
For example, to configure environment variables for the Garbage collector:
77104

78-
```yaml
79-
apiVersion: kubecfg.dev/v1alpha1
80-
kind: AppInstance
81-
metadata:
82-
name: influxdb
83-
namespace: influxdb
105+
{{< code-tabs-wrapper >}}
106+
{{% code-tabs %}}
107+
[AppInstance](#)
108+
[Helm](#)
109+
{{% /code-tabs %}}
110+
{{% code-tab-content %}}
111+
```yaml
112+
apiVersion: kubecfg.dev/v1alpha1
113+
kind: AppInstance
114+
metadata:
115+
name: influxdb
116+
namespace: influxdb
117+
spec:
118+
package:
119+
# ...
84120
spec:
85-
package:
86-
# ...
87-
spec:
88-
components:
89-
garbage-collector:
90-
template:
91-
containers:
92-
iox:
93-
env:
94-
INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '6h'
95-
INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF: '6h'
96-
```
97-
98-
3. Use `kubectl apply` to apply the configuration changes to your cluster and
99-
add or update environment variables in each component.
100-
101-
<!-- pytest.mark.skip -->
102-
103-
```bash
104-
kubectl apply \
105-
--filename myinfluxdb.yml \
106-
--namespace influxdb
107-
```
121+
components:
122+
garbage-collector:
123+
template:
124+
containers:
125+
iox:
126+
env:
127+
INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '6h'
128+
INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF: '6h'
129+
```
130+
{{% /code-tab-content %}}
131+
{{% code-tab-content %}}
132+
```yaml
133+
# ...
134+
components:
135+
garbage-collector:
136+
template:
137+
containers:
138+
iox:
139+
env:
140+
INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '6h'
141+
INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF: '6h'
142+
```
143+
{{% /code-tab-content %}}
144+
{{< /code-tabs-wrapper >}}
145+
146+
3. Apply the configuration changes to your cluster and add or update
147+
environment variables in each component.
148+
149+
{{< code-tabs-wrapper >}}
150+
{{% code-tabs %}}
151+
[AppInstance](#)
152+
[Helm](#)
153+
{{% /code-tabs %}}
154+
{{% code-tab-content %}}
155+
<!-- pytest.mark.skip -->
156+
157+
```bash
158+
kubectl apply \
159+
--filename myinfluxdb.yml \
160+
--namespace influxdb
161+
```
162+
{{% /code-tab-content %}}
163+
{{% code-tab-content %}}
164+
<!-- pytest.mark.skip -->
165+
166+
```bash
167+
helm upgrade \
168+
influxdata/influxdb3-clustered \
169+
-f ./values.yml \
170+
--namespace influxdb
171+
```
172+
{{% /code-tab-content %}}
173+
{{< /code-tabs-wrapper >}}
174+
108175
{{% note %}}
109176
#### Update environment variables instead of removing them
110177

@@ -124,6 +191,12 @@ the `env` property, the cutoff reverts to its default setting of `30d`.
124191
{{< expand-wrapper >}}
125192
{{% expand "View example of environment variables in all components" %}}
126193

194+
{{< code-tabs-wrapper >}}
195+
{{% code-tabs %}}
196+
[AppInstance](#)
197+
[Helm](#)
198+
{{% /code-tabs %}}
199+
{{% code-tab-content %}}
127200
```yaml
128201
apiVersion: kubecfg.dev/v1alpha1
129202
kind: AppInstance
@@ -135,37 +208,77 @@ spec:
135208
# ...
136209
spec:
137210
components:
138-
ingester:
139-
template:
140-
containers:
141-
iox:
142-
env:
143-
INFLUXDB_IOX_WAL_ROTATION_PERIOD_SECONDS: '360'
144-
querier:
145-
template:
146-
containers:
147-
iox:
148-
env:
149-
INFLUXDB_IOX_EXEC_MEM_POOL_BYTES: '10737418240' # 10GiB
150-
router:
151-
template:
152-
containers:
153-
iox:
154-
env:
155-
INFLUXDB_IOX_MAX_HTTP_REQUESTS: '5000'
156-
compactor:
157-
template:
158-
containers:
159-
iox:
160-
env:
161-
INFLUXDB_IOX_EXEC_MEM_POOL_PERCENT: '80'
162-
garbage-collector:
163-
template:
164-
containers:
165-
iox:
166-
env:
167-
INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '6h'
168-
INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF: '6h'
211+
ingester:
212+
template:
213+
containers:
214+
iox:
215+
env:
216+
INFLUXDB_IOX_WAL_ROTATION_PERIOD_SECONDS: '360'
217+
querier:
218+
template:
219+
containers:
220+
iox:
221+
env:
222+
INFLUXDB_IOX_EXEC_MEM_POOL_BYTES: '10737418240' # 10GiB
223+
router:
224+
template:
225+
containers:
226+
iox:
227+
env:
228+
INFLUXDB_IOX_MAX_HTTP_REQUESTS: '5000'
229+
compactor:
230+
template:
231+
containers:
232+
iox:
233+
env:
234+
INFLUXDB_IOX_EXEC_MEM_POOL_PERCENT: '80'
235+
garbage-collector:
236+
template:
237+
containers:
238+
iox:
239+
env:
240+
INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '6h'
241+
INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF: '6h'
169242
```
243+
{{% /code-tab-content %}}
244+
{{% code-tab-content %}}
245+
```yaml
246+
# ...
247+
components:
248+
ingester:
249+
template:
250+
containers:
251+
iox:
252+
env:
253+
INFLUXDB_IOX_WAL_ROTATION_PERIOD_SECONDS: '360'
254+
querier:
255+
template:
256+
containers:
257+
iox:
258+
env:
259+
INFLUXDB_IOX_EXEC_MEM_POOL_BYTES: '10737418240' # 10GiB
260+
router:
261+
template:
262+
containers:
263+
iox:
264+
env:
265+
INFLUXDB_IOX_MAX_HTTP_REQUESTS: '5000'
266+
compactor:
267+
template:
268+
containers:
269+
iox:
270+
env:
271+
INFLUXDB_IOX_EXEC_MEM_POOL_PERCENT: '80'
272+
garbage-collector:
273+
template:
274+
containers:
275+
iox:
276+
env:
277+
INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '6h'
278+
INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF: '6h'
279+
```
280+
{{% /code-tab-content %}}
281+
{{< /code-tabs-wrapper >}}
282+
170283
{{% /expand %}}
171284
{{< /expand-wrapper >}}

0 commit comments

Comments
 (0)