@@ -89,6 +89,8 @@ The `AppInstance` resource contains key information, such as:
89
89
Copy the provided ` example-customer.yml ` file to create a new configuration file
90
90
specific to your InfluxDB cluster. For example, ` myinfluxdb.yml ` .
91
91
92
+ <!-- pytest.mark.skip -->
93
+
92
94
``` sh
93
95
cp example-customer.yml myinfluxdb.yml
94
96
```
@@ -106,6 +108,8 @@ InfluxData provides an `app-instance-schema.json` JSON schema file that VS Code
106
108
107
109
Create a namespace for InfluxDB--for example, enter the following ` kubectl ` command in your terminal:
108
110
111
+ <!-- pytest.mark.skip -->
112
+
109
113
``` sh
110
114
kubectl create namespace influxdb
111
115
```
@@ -122,6 +126,8 @@ update an InfluxDB cluster.
122
126
123
127
Use ` kubectl ` to install the [ kubecfg kubit] ( https://github.com/kubecfg/kubit ) operator.
124
128
129
+ <!-- pytest.mark.skip -->
130
+
125
131
``` sh
126
132
kubectl apply -k ' https://github.com/kubecfg/kubit//kustomize/global?ref=v0.0.15'
127
133
```
@@ -148,6 +154,8 @@ Use [crane](https://github.com/google/go-containerregistry/tree/main/cmd/crane)
148
154
149
155
{{% code-placeholders "PACKAGE_VERSION" %}}
150
156
157
+ <!-- pytest.mark.skip -->
158
+
151
159
``` sh
152
160
mkdir /tmp/influxdbsecret
153
161
cp influxdb-docker-config.json /tmp/influxdbsecret/config.json
@@ -256,6 +264,8 @@ You can obtain it with any standard OCI image inspection tool. For example:
256
264
257
265
{{% code-placeholders "PACKAGE_VERSION" %}}
258
266
267
+ <!-- pytest.mark.skip -->
268
+
259
269
``` sh
260
270
DOCKER_CONFIG=/tmp/influxdbsecret \
261
271
crane config \
@@ -278,6 +288,8 @@ Use `crane` to copy the images to your private registry:
278
288
279
289
{{% code-placeholders "REGISTRY_HOSTNAME" %}}
280
290
291
+ <!-- pytest.mark.skip -->
292
+
281
293
``` sh
282
294
< /tmp/images.txt xargs -I% crane cp % REGISTRY_HOSTNAME/%
283
295
```
@@ -334,6 +346,8 @@ cluster as a secret. Provide the paths to the TLS certificate file and key file:
334
346
335
347
{{% code-placeholders "TLS_(CERT|KEY)_PATH" %}}
336
348
349
+ <!-- pytest.mark.skip -->
350
+
337
351
` ` ` sh
338
352
kubectl create secret tls ingress-tls \
339
353
--namespace influxdb \
@@ -735,34 +749,37 @@ Replace the following:
735
749
{{% /code-tab-content %}}
736
750
{{< /code-tabs-wrapper >}}
737
751
738
- # #### Adding users
752
+ # #### Add users
739
753
740
- Finally, add all the users you wish to have access to use `influxctl`.
741
- Update the `spec.package.spec.admin.users` field with a list of these users.
754
+ Finally, to give users access to use `influxctl`, add the list of users to the `spec.package.spec.admin.users` field.
755
+
756
+ <!-- Pending /admin/users
742
757
See [Adding or removing users](/influxdb/clustered/admin/users/) for more details.
758
+ -->
743
759
744
760
# ### Configure the size of your cluster
745
761
746
- By default, an InfluxDB cluster is configured with the following :
762
+ # #### Default scale settings
747
763
748
- - **3 ingesters**:
764
+ - **3 ingesters**:
749
765
Ensures redundancy on the write path.
750
- - **1 compactor**:
766
+ - **1 compactor**:
751
767
While you can have multiple compactors, it is more efficient to scale the
752
768
compactor vertically (assign more CPU and memory) rather than horizontally
753
769
(increase the number of compactors).
754
- - **1 querier**:
770
+ - **1 querier**:
755
771
The optimal number of queriers depends on the number of concurrent queries you are
756
772
likely to have and how long they take to execute.
757
773
758
774
The default values provide a good starting point for testing.
759
- Once you have your cluster up and running and are looking for scaling recommendations,
775
+ Once you have your cluster up and running and are looking for scaling recommendations
776
+ for your anticipated workload,
760
777
please [contact the InfluxData Support team](https://support.influxdata.com).
761
- We are happy to work with you to identify appropriate scale settings based on
762
- your anticipated workload.
763
778
764
- **To use custom scale settings for your InfluxDB cluster**, modify the following fields
765
- in your `myinfluxdb.yml`. If omitted, your cluster will use the default scale settings.
779
+ # #### Customize scale settings
780
+
781
+ **To use custom scale settings for your InfluxDB cluster**, edit values for the following fields
782
+ in your `myinfluxdb.yml`. If omitted, your cluster uses the default scale settings.
766
783
767
784
- ` spec.package.spec.resources`
768
785
- ` ingester.requests`
@@ -833,44 +850,53 @@ spec:
833
850
834
851
# ## Provide a custom certificate authority bundle {note="Optional"}
835
852
836
- InfluxDB attempts to make TLS connections to the services it depends on; notably
837
- the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog),
853
+ InfluxDB attempts to make TLS connections to the services it depends on-- notably,
854
+ the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog)
838
855
and the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store).
839
- InfluxDB validates the certificates for all of the connections it makes .
856
+ InfluxDB validates certificates for all connections.
840
857
841
- **If you host these services yourself and you use a private or otherwise not
842
- well-known certificate authority to issue certificates to theses services**,
843
- InfluxDB will not recognize the issuer and will be unable to validate the certificates.
844
- To allow InfluxDB to validate these certificates, provide a PEM certificate
845
- bundle containing your custom certificate authority chain.
858
+ _If you host dependent services yourself and you use a private or otherwise not
859
+ well-known certificate authority to issue certificates to them,
860
+ InfluxDB won't recognize the issuer and can't validate the certificates._
861
+ To allow InfluxDB to validate the certificates from your custom CA,
862
+ configure the `AppInstance` resource to use a **PEM certificate
863
+ bundle** that contains your custom certificate authority chain.
846
864
847
- 1. Use `kubectl` to create a config map containing your PEM bundle.
865
+ 1. Use `kubectl` to create a config map that contains your PEM-formatted
866
+ certificate bundle file.
848
867
Your certificate authority administrator should provide you with a
849
- PEM-formatted certificate bundle file.
868
+ PEM-formatted bundle file.
850
869
851
870
{{% note %}}
852
- This PEM-formatted bundle file is *not* the certificate that InfluxDB uses to
853
- host its own TLS endpoints. This bundle establishes a chain of trust for the
871
+ This PEM bundle file establishes a chain of trust for the
854
872
external services that InfluxDB depends on.
873
+ It's *not* the certificate that InfluxDB uses to
874
+ host its own TLS endpoints.
855
875
{{% /note %}}
856
876
857
- In the example below, `private_ca.pem` is the certificate bundle file.
877
+ In the example, replace `/path/to/private_ca.pem` with the path to your PEM-formatted certificate bundle file :
878
+
879
+ <!-- pytest.mark.skip -->
858
880
859
881
` ` ` sh
860
882
kubectl --namespace influxdb create configmap custom-ca --from-file=certs.pem=/path/to/private_ca.pem
861
883
` ` `
862
884
863
885
{{% note %}}
864
- It's possible to append multiple certificates into the same bundle.
865
- This can help if you need to include intermediate certificates or explicitly
866
- include leaf certificates. Leaf certificates should be included before any
867
- intermediate certificates they depend on. The root certificate should
868
- be last in the bundle.
886
+ # ### Bundle multiple certificates
887
+
888
+ You can append multiple certificates into the same bundle.
889
+ This approach helps when you need to include intermediate certificates or explicitly include leaf certificates.
890
+
891
+ Include certificates in the bundle in the following order :
892
+
893
+ 1. Leaf certificates
894
+ 2. Intermediate certificates required by leaf certificates
895
+ 3. Root certificate
869
896
{{% /note %}}
870
897
871
- 2. Update your `AppInstance` resource in your `myinfluxdb.yml` to refer to your
872
- certificate authority config map. Update the `.spec.package.spec.egress`
873
- property to refer to that config map. For example :
898
+ 2. In `myinfluxdb.yml`, update the `.spec.package.spec.egress` field to refer
899
+ to the config map that you generated in the preceding step--for example :
874
900
875
901
` ` ` yml
876
902
spec:
0 commit comments