Skip to content

Commit 1cae8c8

Browse files
committed
chore(clustered): cleanup
1 parent ae7778d commit 1cae8c8

File tree

1 file changed

+43
-22
lines changed
  • content/influxdb/clustered/install/configure-cluster

1 file changed

+43
-22
lines changed

content/influxdb/clustered/install/configure-cluster/directly.md

Lines changed: 43 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The `AppInstance` resource contains key information, such as:
8989
Copy the provided `example-customer.yml` file to create a new configuration file
9090
specific to your InfluxDB cluster. For example, `myinfluxdb.yml`.
9191

92-
<!-- pymark.mark.skip -->
92+
<!-- pytest.mark.skip -->
9393

9494
```sh
9595
cp example-customer.yml myinfluxdb.yml
@@ -108,6 +108,8 @@ InfluxData provides an `app-instance-schema.json` JSON schema file that VS Code
108108

109109
Create a namespace for InfluxDB--for example, enter the following `kubectl` command in your terminal:
110110

111+
<!-- pytest.mark.skip -->
112+
111113
```sh
112114
kubectl create namespace influxdb
113115
```
@@ -124,6 +126,8 @@ update an InfluxDB cluster.
124126

125127
Use `kubectl` to install the [kubecfg kubit](https://github.com/kubecfg/kubit) operator.
126128

129+
<!-- pytest.mark.skip -->
130+
127131
```sh
128132
kubectl apply -k 'https://github.com/kubecfg/kubit//kustomize/global?ref=v0.0.15'
129133
```
@@ -150,6 +154,8 @@ Use [crane](https://github.com/google/go-containerregistry/tree/main/cmd/crane)
150154

151155
{{% code-placeholders "PACKAGE_VERSION" %}}
152156

157+
<!-- pytest.mark.skip -->
158+
153159
```sh
154160
mkdir /tmp/influxdbsecret
155161
cp influxdb-docker-config.json /tmp/influxdbsecret/config.json
@@ -258,6 +264,8 @@ You can obtain it with any standard OCI image inspection tool. For example:
258264

259265
{{% code-placeholders "PACKAGE_VERSION" %}}
260266

267+
<!-- pytest.mark.skip -->
268+
261269
```sh
262270
DOCKER_CONFIG=/tmp/influxdbsecret \
263271
crane config \
@@ -280,6 +288,8 @@ Use `crane` to copy the images to your private registry:
280288

281289
{{% code-placeholders "REGISTRY_HOSTNAME" %}}
282290

291+
<!-- pytest.mark.skip -->
292+
283293
```sh
284294
</tmp/images.txt xargs -I% crane cp % REGISTRY_HOSTNAME/%
285295
```
@@ -336,6 +346,8 @@ cluster as a secret. Provide the paths to the TLS certificate file and key file:
336346
337347
{{% code-placeholders "TLS_(CERT|KEY)_PATH" %}}
338348
349+
<!-- pytest.mark.skip -->
350+
339351
```sh
340352
kubectl create secret tls ingress-tls \
341353
--namespace influxdb \
@@ -838,44 +850,53 @@ spec:
838850

839851
### Provide a custom certificate authority bundle {note="Optional"}
840852

841-
InfluxDB attempts to make TLS connections to the services it depends on; notably
842-
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)
843855
and the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store).
844-
InfluxDB validates the certificates for all of the connections it makes.
856+
InfluxDB validates certificates for all connections.
845857

846-
**If you host these services yourself and you use a private or otherwise not
847-
well-known certificate authority to issue certificates to theses services**,
848-
InfluxDB will not recognize the issuer and will be unable to validate the certificates.
849-
To allow InfluxDB to validate these certificates, provide a PEM certificate
850-
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.
851864

852-
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.
853867
Your certificate authority administrator should provide you with a
854-
PEM-formatted certificate bundle file.
868+
PEM-formatted bundle file.
855869

856870
{{% note %}}
857-
This PEM-formatted bundle file is *not* the certificate that InfluxDB uses to
858-
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
859872
external services that InfluxDB depends on.
873+
It's *not* the certificate that InfluxDB uses to
874+
host its own TLS endpoints.
860875
{{% /note %}}
861876

862-
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 -->
863880

864881
```sh
865882
kubectl --namespace influxdb create configmap custom-ca --from-file=certs.pem=/path/to/private_ca.pem
866883
```
867884

868885
{{% note %}}
869-
It's possible to append multiple certificates into the same bundle.
870-
This can help if you need to include intermediate certificates or explicitly
871-
include leaf certificates. Leaf certificates should be included before any
872-
intermediate certificates they depend on. The root certificate should
873-
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
874896
{{% /note %}}
875897

876-
2. Update your `AppInstance` resource in your `myinfluxdb.yml` to refer to your
877-
certificate authority config map. Update the `.spec.package.spec.egress`
878-
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:
879900

880901
```yml
881902
spec:

0 commit comments

Comments
 (0)