Merge pull request #6148 from influxdata/jts-monolith-gs-restructure

Jts monolith gs restructure

Author: jstirnaman

.gitignore

@@ -15,7 +15,7 @@ node_modules
 !telegraf-build/templates
 !telegraf-build/scripts
 !telegraf-build/README.md
-/cypress/downloads
+/cypress/downloads/*
 /cypress/screenshots/*
 /cypress/videos/*
 test-results.xml
@@ -25,4 +25,4 @@ test-results.xml
 .idea
 **/config.toml
 package-lock.json
-tmp
+tmp

content/influxdb3/clustered/reference/release-notes/clustered.md

@@ -250,8 +250,8 @@ spec:
 
 #### Release artifacts
 
-- [app-instance-schema.json](/downloads/clustered-release-artifacts/20241022-1346953/app-instance-schema.json)
-- [example-customer.yml](/downloads/clustered-release-artifacts/20241022-1346953/example-customer.yml)
+- [app-instance-schema.json](/downloads/clustered-release-artifacts/20241024-1354148/app-instance-schema.json)
+- [example-customer.yml](/downloads/clustered-release-artifacts/20241024-1354148/example-customer.yml)
 - [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
 
 ### Known Bugs
@@ -804,13 +804,13 @@ version of `influxctl` prior to v2.8.0.
 ```yaml
 spec:
   package:
-    image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20240325-920726
+    image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20240326-922145
 ```
 
 #### Release artifacts
 
-- [app-instance-schema.json](/downloads/clustered-release-artifacts/20240325-920726/app-instance-schema.json)
-- [example-customer.yml](/downloads/clustered-release-artifacts/20240325-920726/example-customer.yml)
+- [app-instance-schema.json](/downloads/clustered-release-artifacts/20240326-922145/app-instance-schema.json)
+- [example-customer.yml](/downloads/clustered-release-artifacts/20240326-922145/example-customer.yml)
 - [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
 
 ### Highlights

content/influxdb3/core/get-started/processing-engine.md renamed to content/influxdb3/core/get-started/process.md

@@ -11,6 +11,9 @@ menu:
     identifier: gs-process-data
     parent: Get started
 weight: 104
+aliases:
+  - /influxdb3/core/get-started/process-data/
+  - /influxdb3/core/get-started/processing-engine/
 related:
   - /influxdb3/core/plugins/
   - /influxdb3/core/reference/cli/influxdb3/create/plugin/

content/influxdb3/enterprise/admin/license.md

@@ -101,7 +101,7 @@ The license file is a JWT file that contains the license information.
 > use one of the methods to [skip the email prompt](#skip-the-email-prompt). 
 > This ensures that the container can generate the license file after you
 > verify your email address.
-> See the [Docker Compose example](?t=Docker+compose#activate-a-trial-or-home-license-with-docker).
+> See the [Docker Compose example](?t=Docker+compose#start-with-license-email-and-compose).
 
 #### Skip the email prompt
 
@@ -186,7 +186,7 @@ existing license if it's still valid.
 {{% code-tabs %}}
 [influxdb3 options](#)
 [Environment variables](#)
-[Docker compose](#example-activate-trial-or-home-with-compose)
+[Docker compose](#start-with-license-email-and-compose)
 {{% /code-tabs %}}
 {{% code-tab-content %}}
 <!------------------------ BEGIN INFLUXDB3 CLI OPTIONS ------------------------>
@@ -215,6 +215,7 @@ influxdb3 serve \
 {{% /code-tab-content %}}
 {{% code-tab-content %}}
 <!------------------------ BEGIN DOCKER COMPOSE ------------------------>
+{{% code-placeholders "${EMAIL_ADDRESS}" %}}
 ```yaml
 # compose.yaml
 name: data-crunching-stack
@@ -235,7 +236,8 @@ services:
       - --object-store=file
       - --data-dir=/var/lib/influxdb3
       - --plugin-dir=/var/lib/influxdb3/plugins
-      - --license-email=INFLUXDB3_LICENSE_EMAIL
+    environment:
+      - INFLUXDB3_LICENSE_EMAIL=${EMAIL_ADDRESS}
     volumes:
       - type: bind 
         source: ~/.influxdb3/data
@@ -244,6 +246,9 @@ services:
         source: ~/.influxdb3/plugins
         target: /var/lib/influxdb3/plugins
 ```
+{{% /code-placeholders %}}
+Replace {{% code-placeholder-key %}}`${EMAIL_ADDRESS}`{{% /code-placeholder-key %}} with your email address
+or a variable from your Compose `.env` file.
 <!------------------------- END DOCKER COMPOSE ------------------------->
 {{% /code-tab-content %}}
 {{< /code-tabs-wrapper >}}

content/influxdb3/enterprise/install/multi-server.md renamed to content/influxdb3/enterprise/get-started/multi-server.md

@@ -7,49 +7,88 @@ description: >
 menu:
   influxdb3_enterprise:
     name: Create a multi-node cluster
-    parent: Install InfluxDB 3 Enterprise
-weight: 101
+    parent: Get started
+    identifier: gs-multi-node-cluster 
+weight: 102
 influxdb3/enterprise/tags: [cluster, multi-node, multi-server]
 ---
 
-{{% product-name %}} supports flexible, multi-node configurations for high
-availability, performance, read replicas, and more to meet the specific needs
-of your use case.
-The {{% product-name %}} server can run in different _modes_ fulfil specific roles
-in your multi-node cluster.
-With the diskless architecture, all nodes in the cluster share the same common
-object store.
+Create a multi-node {{% product-name %}} cluster for high availability, performance, and workload isolation.
+Configure nodes with specific _modes_ (ingest, query, process, compact) to optimize for your use case.
+
+## Prerequisites
+
+- Shared object store
+- Network connectivity between nodes
+
+## Basic multi-node setup
+
+<!-- pytest.mark.skip -->
+```bash
+## NODE 1 compacts stored data
+
+# Example variables
+# node-id: 'host01'
+# cluster-id: 'cluster01'
+# bucket: 'influxdb-3-enterprise-storage'
+
+influxdb3 serve \
+  --node-id host01 \
+  --cluster-id cluster01 \
+  --mode ingest,query,compact \
+  --object-store s3 \
+  --bucket influxdb-3-enterprise-storage \
+  --http-bind {{< influxdb/host >}} \
+  --aws-access-key-id <AWS_ACCESS_KEY_ID> \
+  --aws-secret-access-key <AWS_SECRET_ACCESS_KEY>
+```
+
+<!-- pytest.mark.skip -->
+```bash
+## NODE 2 handles writes and queries 
+
+# Example variables
+# node-id: 'host02'
+# cluster-id: 'cluster01'
+# bucket: 'influxdb-3-enterprise-storage'
+
+influxdb3 serve \
+  --node-id host02 \
+  --cluster-id cluster01 \
+  --mode ingest,query \
+  --object-store s3 \
+  --bucket influxdb-3-enterprise-storage \
+  --http-bind localhost:8282 \
+  --aws-access-key-id AWS_ACCESS_KEY_ID \
+  --aws-secret-access-key AWS_SECRET_ACCESS_KEY
+```
+
+Learn how to set up a multi-node cluster for different use cases, including high availability, read replicas, processing data, and workload isolation.
 
 - [Create an object store](#create-an-object-store)
 - [Connect to your object store](#connect-to-your-object-store)
 - [Server modes](#server-modes)
-  - [Server mode examples](#server-mode-examples)
-    - [Configure a node to only handle write requests](#configure-a-node-to-only-handle-write-requests)
-    - [Configure a node to only run the Compactor](#configure-a-node-to-only-run-the-compactor)
-    - [Configure a handle query requests and run the processing engine](#configure-a-handle-query-requests-and-run-the-processing-engine)
-- [InfluxDB 3 Enterprise cluster configuration examples](#influxdb-3-enterprise-cluster-configuration-examples)
-  - [High availability cluster](#high-availability-cluster)
-  - [High availability with a dedicated Compactor](#high-availability-with-a-dedicated-compactor)
-  - [High availability with read replicas and a dedicated Compactor](#high-availability-with-read-replicas-and-a-dedicated-compactor)
+- [Cluster configuration examples](#cluster-configuration-examples)
 - [Writing and querying in multi-node clusters](#writing-and-querying-in-multi-node-clusters)
 
 ## Create an object store
 
-To run a mulit-node {{% product-name %}} cluster, nodes must connect to a
-common object store. Enterprise supports the following object stores:
+With the {{% product-name %}} diskless architecture, all data is stored in a common object store.
+In a multi-node cluster, you connect all nodes to the same object store.
+
+Enterprise supports the following object stores:
 
 - AWS S3 (or S3-compatible)
 - Azure Blob Storage
 - Google Cloud Storage
 
 > [!Note]
-> Refer to your object storage provider's documentation for information about
+> Refer to your object storage provider's documentation for 
 > setting up an object store.
 
 ## Connect to your object store
 
-Depending on your object storage provider, connect nodes in your cluster to the
-object store by including provider-specific options when starting each node.
+When starting your {{% product-name %}} node, include provider-specific options for connecting to your object store--for example:
 
 {{< tabs-wrapper >}}
 {{% tabs %}}
@@ -73,7 +112,7 @@ with your `influxdb3 serve` command:
 {{% code-placeholders "AWS_(BUCKET_NAME|ACCESS_KEY_ID|SECRET_ACCESS_KEY)" %}}
 <!-- pytest.mark.skip -->
 ```bash
-influxdb3 server \
+influxdb3 serve \
   # ...
   --object-store s3 \
   --bucket AWS_BUCKET_NAME \
@@ -103,7 +142,7 @@ with your `influxdb3 serve` command:
 {{% code-placeholders "AZURE_(CONTAINER_NAME|STORAGE_ACCOUNT|STORAGE_ACCESS_KEY)" %}}
 <!-- pytest.mark.skip -->
 ```bash
-influxdb3 server \
+influxdb3 serve \
   # ...
   --object-store azure \
   --bucket AZURE_CONTAINER_NAME \
@@ -128,7 +167,7 @@ with your `influxdb3 serve` command:
 {{% code-placeholders "GOOGLE_(BUCKET_NAME|SERVICE_ACCOUNT)" %}}
 <!-- pytest.mark.skip -->
 ```bash
-influxdb3 server \
+influxdb3 serve \
   # ...
   --object-store google \
   --bucket GOOGLE_BUCKET_NAME \
@@ -163,31 +202,32 @@ Each node can run in one _or more_ of the following modes:
 #### Configure a node to only handle write requests
 <!-- pytest.mark.skip -->
 ```bash
-influxdb3 server \
+influxdb3 serve \
   # ...
   --mode ingest
 ```
 
 #### Configure a node to only run the Compactor
 <!-- pytest.mark.skip -->
 ```bash
-influxdb3 server \
+influxdb3 serve \
   # ...
   --mode compact
 ```
 
-#### Configure a handle query requests and run the processing engine
+#### Configure a node to handle queries and run the processing engine 
 <!-- pytest.mark.skip -->
 ```bash
-influxdb3 server \
+influxdb3 serve \
   # ...
   --mode query,process
 ```
 
+## Cluster configuration examples
 
-## {{% product-name %}} cluster configuration examples
-
-<!-- Placeholder for links -->
+- [High availability cluster](#high-availability-cluster)
+- [High availability with a dedicated Compactor](#high-availability-with-a-dedicated-compactor)
+- [High availability with read replicas and a dedicated Compactor](#high-availability-with-read-replicas-and-a-dedicated-compactor)
 
 ### High availability cluster
 
@@ -479,3 +519,10 @@ Replace the following placeholders with your values:
 - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link "database" %}}{{% show-in "enterprise" %}} with permission to query the specified database{{% /show-in %}}
 - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the database to query
 - {{% code-placeholder-key %}}`QUERY`{{% /code-placeholder-key %}}: the SQL or InfluxQL query to run against the database
+
+{{% page-nav
+  prev="/influxdb3/enterprise/get-started/setup/"
+  prevText="Set up InfluxDB"
+  next="/influxdb3/enterprise/get-started/write/"
+  nextText="Write data"
+%}}

content/influxdb3/enterprise/get-started/processing-engine.md renamed to content/influxdb3/enterprise/get-started/process.md

@@ -10,7 +10,10 @@ menu:
     name: Process data
     identifier: gs-process-data
     parent: Get started
-weight: 104
+weight: 105
+aliases:
+  - /influxdb3/enterprise/get-started/process-data/
+  - /influxdb3/enterprise/get-started/processing-engine/
 related:
   - /influxdb3/enterprise/plugins/
   - /influxdb3/enterprise/reference/cli/influxdb3/create/plugin/

content/influxdb3/enterprise/get-started/query.md

@@ -9,7 +9,7 @@ menu:
     name: Query data
     identifier: gs-query-data
     parent: Get started
-weight: 103
+weight: 104
 related:
   - /influxdb3/enterprise/query-data/
   - /influxdb3/enterprise/reference/sql/

content/influxdb3/enterprise/get-started/write.md

@@ -9,7 +9,7 @@ menu:
     name: Write data
     identifier: gs-write-data
     parent: Get started
-weight: 102
+weight: 103
 related:
   - /influxdb3/enterprise/write-data/
   - /influxdb3/enterprise/reference/line-protocol/

content/influxdb3/enterprise/reference/cli/influxdb3/create/token/_index.md

@@ -4,7 +4,7 @@ description: >
   The `influxdb3 create token` command creates an admin token or a scoped resource token for authenticating and authorizing actions in an {{% product-name %}} instance.
 menu:
   influxdb3_enterprise:
-    parent: influxdb3
+    parent: influxdb3 create
     name: influxdb3 create token
 weight: 300
 source: /shared/influxdb3-cli/create/token/_index.md

content/influxdb3/enterprise/reference/config-options.md

@@ -320,7 +320,6 @@ The server processes all requests without requiring tokens or authentication.
 Optionally disable authz by passing in a comma separated list of resources. 
 Valid values are `health`, `ping`, and `metrics`.
 
-
 ---
 
 ### AWS