Skip to content

Commit b176d61

Browse files
authored
Merge pull request #5553 from influxdata/dar-clustered-users-page
fix: link to missing Clustered users page
2 parents 77f06eb + 1cae8c8 commit b176d61

File tree

1 file changed

+59
-33
lines changed
  • content/influxdb/clustered/install/configure-cluster

1 file changed

+59
-33
lines changed

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

Lines changed: 59 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ 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+
<!-- pytest.mark.skip -->
93+
9294
```sh
9395
cp example-customer.yml myinfluxdb.yml
9496
```
@@ -106,6 +108,8 @@ InfluxData provides an `app-instance-schema.json` JSON schema file that VS Code
106108

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

111+
<!-- pytest.mark.skip -->
112+
109113
```sh
110114
kubectl create namespace influxdb
111115
```
@@ -122,6 +126,8 @@ update an InfluxDB cluster.
122126

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

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

149155
{{% code-placeholders "PACKAGE_VERSION" %}}
150156

157+
<!-- pytest.mark.skip -->
158+
151159
```sh
152160
mkdir /tmp/influxdbsecret
153161
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:
256264

257265
{{% code-placeholders "PACKAGE_VERSION" %}}
258266

267+
<!-- pytest.mark.skip -->
268+
259269
```sh
260270
DOCKER_CONFIG=/tmp/influxdbsecret \
261271
crane config \
@@ -278,6 +288,8 @@ Use `crane` to copy the images to your private registry:
278288

279289
{{% code-placeholders "REGISTRY_HOSTNAME" %}}
280290

291+
<!-- pytest.mark.skip -->
292+
281293
```sh
282294
</tmp/images.txt xargs -I% crane cp % REGISTRY_HOSTNAME/%
283295
```
@@ -334,6 +346,8 @@ cluster as a secret. Provide the paths to the TLS certificate file and key file:
334346
335347
{{% code-placeholders "TLS_(CERT|KEY)_PATH" %}}
336348
349+
<!-- pytest.mark.skip -->
350+
337351
```sh
338352
kubectl create secret tls ingress-tls \
339353
--namespace influxdb \
@@ -735,34 +749,37 @@ Replace the following:
735749
{{% /code-tab-content %}}
736750
{{< /code-tabs-wrapper >}}
737751

738-
##### Adding users
752+
##### Add users
739753

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
742757
See [Adding or removing users](/influxdb/clustered/admin/users/) for more details.
758+
-->
743759

744760
#### Configure the size of your cluster
745761

746-
By default, an InfluxDB cluster is configured with the following:
762+
##### Default scale settings
747763

748-
- **3 ingesters**:
764+
- **3 ingesters**:
749765
Ensures redundancy on the write path.
750-
- **1 compactor**:
766+
- **1 compactor**:
751767
While you can have multiple compactors, it is more efficient to scale the
752768
compactor vertically (assign more CPU and memory) rather than horizontally
753769
(increase the number of compactors).
754-
- **1 querier**:
770+
- **1 querier**:
755771
The optimal number of queriers depends on the number of concurrent queries you are
756772
likely to have and how long they take to execute.
757773

758774
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,
760777
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.
763778

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.
766783

767784
- `spec.package.spec.resources`
768785
- `ingester.requests`
@@ -833,44 +850,53 @@ spec:
833850

834851
### Provide a custom certificate authority bundle {note="Optional"}
835852

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)
838855
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.
840857

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.
846864

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.
848867
Your certificate authority administrator should provide you with a
849-
PEM-formatted certificate bundle file.
868+
PEM-formatted bundle file.
850869

851870
{{% 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
854872
external services that InfluxDB depends on.
873+
It's *not* the certificate that InfluxDB uses to
874+
host its own TLS endpoints.
855875
{{% /note %}}
856876

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 -->
858880

859881
```sh
860882
kubectl --namespace influxdb create configmap custom-ca --from-file=certs.pem=/path/to/private_ca.pem
861883
```
862884

863885
{{% 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
869896
{{% /note %}}
870897

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:
874900

875901
```yml
876902
spec:

0 commit comments

Comments
 (0)