Skip to content

Commit 29a81be

Browse files
committed
fix(influxdb3): Get started fixes
1 parent 6abda20 commit 29a81be

File tree

6 files changed

+38
-76
lines changed

6 files changed

+38
-76
lines changed

content/influxdb3/enterprise/admin/license.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The license file is a JWT file that contains the license information.
101101
> use one of the methods to [skip the email prompt](#skip-the-email-prompt).
102102
> This ensures that the container can generate the license file after you
103103
> verify your email address.
104-
> See the [Docker Compose example](?t=Docker+compose#activate-a-trial-or-home-license-with-docker).
104+
> See the [Docker Compose example](?t=Docker+compose#start-with-license-email-and-compose).
105105
106106
#### Skip the email prompt
107107

@@ -186,7 +186,7 @@ existing license if it's still valid.
186186
{{% code-tabs %}}
187187
[influxdb3 options](#)
188188
[Environment variables](#)
189-
[Docker compose](#example-activate-trial-or-home-with-compose)
189+
[Docker compose](#start-with-license-email-and-compose)
190190
{{% /code-tabs %}}
191191
{{% code-tab-content %}}
192192
<!------------------------ BEGIN INFLUXDB3 CLI OPTIONS ------------------------>
@@ -215,6 +215,7 @@ influxdb3 serve \
215215
{{% /code-tab-content %}}
216216
{{% code-tab-content %}}
217217
<!------------------------ BEGIN DOCKER COMPOSE ------------------------>
218+
{{% code-placeholders "${EMAIL_ADDRESS}" %}}
218219
```yaml
219220
# compose.yaml
220221
name: data-crunching-stack
@@ -235,7 +236,8 @@ services:
235236
- --object-store=file
236237
- --data-dir=/var/lib/influxdb3
237238
- --plugin-dir=/var/lib/influxdb3/plugins
238-
- --license-email=INFLUXDB3_LICENSE_EMAIL
239+
environment:
240+
- INFLUXDB3_LICENSE_EMAIL=${EMAIL_ADDRESS}
239241
volumes:
240242
- type: bind
241243
source: ~/.influxdb3/data
@@ -244,6 +246,9 @@ services:
244246
source: ~/.influxdb3/plugins
245247
target: /var/lib/influxdb3/plugins
246248
```
249+
{{% /code-placeholders %}}
250+
Replace {{% code-placeholder-key %}}`${EMAIL_ADDRESS}`{{% /code-placeholder-key %}} with your email address
251+
or a variable from your Compose `.env` file.
247252
<!------------------------- END DOCKER COMPOSE ------------------------->
248253
{{% /code-tab-content %}}
249254
{{< /code-tabs-wrapper >}}

content/influxdb3/enterprise/install/multi-server.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,7 @@ object store.
2424
- [Connect to your object store](#connect-to-your-object-store)
2525
- [Server modes](#server-modes)
2626
- [Server mode examples](#server-mode-examples)
27-
- [Configure a node to only handle write requests](#configure-a-node-to-only-handle-write-requests)
28-
- [Configure a node to only run the Compactor](#configure-a-node-to-only-run-the-compactor)
29-
- [Configure a handle query requests and run the processing engine](#configure-a-handle-query-requests-and-run-the-processing-engine)
30-
- [InfluxDB 3 Enterprise cluster configuration examples](#influxdb-3-enterprise-cluster-configuration-examples)
27+
- [Cluster configuration examples](#cluster-configuration-examples)
3128
- [High availability cluster](#high-availability-cluster)
3229
- [High availability with a dedicated Compactor](#high-availability-with-a-dedicated-compactor)
3330
- [High availability with read replicas and a dedicated Compactor](#high-availability-with-read-replicas-and-a-dedicated-compactor)
@@ -184,8 +181,7 @@ influxdb3 serve \
184181
--mode query,process
185182
```
186183

187-
188-
## {{% product-name %}} cluster configuration examples
184+
## Cluster configuration examples
189185

190186
<!-- Placeholder for links -->
191187

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,6 @@ The server processes all requests without requiring tokens or authentication.
320320
Optionally disable authz by passing in a comma separated list of resources.
321321
Valid values are `health`, `ping`, and `metrics`.
322322

323-
324323
---
325324

326325
### AWS

content/shared/influxdb3-get-started/processing-engine.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,13 @@ def process_writes(influxdb3_local, table_batches, args=None):
8989
influxdb3_local.info("arg1: " + args["arg1"])
9090

9191
# here we're using arguments provided at the time the trigger was set up
92-
# to feed into paramters that we'll put into a query
92+
# to feed into parameters that we'll put into a query
9393
query_params = {"room": "Kitchen"}
94-
# here's an example of executing a parameterized query. Only SQL is supported.
95-
# It will query the database that the trigger is attached to by default. We'll
96-
# soon have support for querying other DBs.
97-
query_result = influxdb3_local.query("SELECT * FROM home where room = '$host'", query_params)
98-
# the result is a list of Dict that have the column name as key and value as
99-
# value. If you run the WAL test plugin with your plugin against a DB that
100-
# you've written data into, you'll be able to see some results
94+
# The following example shows how to execute a parameterized query. Only SQL is supported.
95+
# It queries the database that the trigger is configured for.
96+
query_result = influxdb3_local.query("SELECT * FROM home where room = '$room'", query_params)
97+
# The result is a list of Dict that have the column name as key and value as
98+
# value.
10199
influxdb3_local.info("query result: " + str(query_result))
102100

103101
# this is the data that is sent when the WAL is flushed of writes the server
@@ -180,18 +178,7 @@ Replace the following:
180178
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: the {{% token-link "admin" %}} for your {{% product-name %}} server
181179
- {{% code-placeholder-key %}}`PLUGIN_FILENAME`{{% /code-placeholder-key %}}: the name of the plugin file to test
182180

183-
The command runs the plugin code with the test data, yields the data to the
184-
plugin code, and then responds with the plugin result.
185-
You can quickly see how the plugin behaves, what data it would have written to
186-
the database, and any errors.
187-
You can then edit your Python code in the plugins directory, and rerun the test.
188-
The server reloads the file for every request to the `test` API.
189-
190-
With the plugin code inside the server plugin directory, and a successful test,
191-
you're ready to create a trigger for your server to run the plugin.
192-
193-
##### Example: Test and run a plugin
194-
181+
### Example: Test a plugin
195182
<!-- pytest.mark.skip -->
196183
```bash
197184
# Test a plugin
@@ -207,6 +194,13 @@ influxdb3 test wal_plugin \
207194
test.py
208195
```
209196

197+
The command runs the plugin code with the test data, yields the data to the
198+
plugin code, and then responds with the plugin result.
199+
You can quickly see how the plugin behaves, what data it would have written to
200+
the database, and any errors.
201+
You can then edit your Python code in the plugins directory, and rerun the test.
202+
The server reloads the file for every request to the `test` API.
203+
210204
For more information, see [`influxdb3 test wal_plugin`](/influxdb3/version/reference/cli/influxdb3/test/wal_plugin/)
211205
or run `influxdb3 test wal_plugin -h`.
212206

content/shared/influxdb3-get-started/setup.md

Lines changed: 13 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!-- TOC -->
22
- [Prerequisites](#prerequisites)
33
- [Start InfluxDB](#start-influxdb)
4-
- [Configure for your object store](#configure-for-your-object-store)
54
- [Object store examples](#object-store-examples)
65
{{% show-in "enterprise" %}}
76
- [Set up licensing](#set-up-licensing)
7+
- [Available license types](#available-license-types)
88
{{% /show-in %}}
99
- [Set up authorization](#set-up-authorization)
1010
- [Create an operator token](#create-an-operator-token)
@@ -18,8 +18,8 @@ To get started, you'll need:
1818

1919
- **{{% product-name %}}**: [Install and verify the latest version](/influxdb3/version/install/) on your system.
2020
- If you want to persist data, have access to one of the following:
21+
- A directory on your local disk where you can persist data (used by examples in this guide)
2122
- S3-compatible object store and credentials
22-
- A directory on your local disk where you can persist data
2323

2424
## Start InfluxDB
2525

@@ -52,13 +52,6 @@ Provide the following:
5252
- `google`: Google Cloud Storage
5353
- `azure`: Azure Blob Storage
5454

55-
> [!Note]
56-
> Examples in this getting started guide use the `file` object
57-
> store to persist data to your local disk.
58-
59-
The following examples show how to start {{% product-name %}} with different
60-
object store configurations.
61-
6255
> [!Note]
6356
> #### Diskless architecture
6457
>
@@ -97,7 +90,7 @@ influxdb3 serve \
9790
```
9891
{{% /show-in %}}
9992

100-
### {{% product-name %}} store examples
93+
### Object store examples
10194

10295
{{< expand-wrapper >}}
10396
{{% expand "File system object store" %}}
@@ -198,10 +191,12 @@ docker run -it \
198191
- --object-store=file
199192
- --data-dir=/var/lib/influxdb3
200193
- --plugins-dir=/var/lib/influxdb3-plugins
201-
- --license-email=EMAIL_ADDRESS
194+
environment:
195+
- INFLUXDB3_LICENSE_EMAIL=EMAIL_ADDRESS
202196
```
203197
_Replace `EMAIL_ADDRESS` with your email address to bypass the email prompt
204-
when generating a trial or at-home license._
198+
when generating a trial or at-home license. For more information, see [Manage your
199+
{{% product-name %}} license](/influxdb3/version/admin/license/)_.
205200
{{% /show-in %}}
206201
{{% show-in "core" %}}
207202
1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example:
@@ -360,7 +355,6 @@ influxdb3 serve --help
360355
## Set up licensing
361356

362357
When you first start a new instance, {{% product-name %}} prompts you to select a
363-
364358
license type.
365359

366360
InfluxDB 3 Enterprise licenses:
@@ -369,7 +363,7 @@ InfluxDB 3 Enterprise licenses:
369363
- **Apply per cluster**, with limits based primarily on CPU cores.
370364
- **Vary by license type**, each offering different capabilities and restrictions.
371365

372-
### Available license types:
366+
### Available license types
373367

374368
- **Trial**: 30-day trial license with full access to InfluxDB 3 Enterprise capabilities.
375369
- **At-Home**: For at-home hobbyist use with limited access to InfluxDB 3 Enterprise capabilities.
@@ -378,40 +372,14 @@ InfluxDB 3 Enterprise licenses:
378372
> [!Important]
379373
> #### Trial and at-home licenses with Docker
380374
>
381-
> To generate a trial or home license for InfluxDB 3 in Docker, the first time
382-
> you start a new instance, provide your email address with the
383-
> `--license-email` option or the
384-
> `INFLUXDB3_LICENSE_EMAIL` environment variable to bypass the licensing
385-
> email prompt--for example, in a Docker Compose file:
386-
>
387-
> {{% code-placeholders "EMAIL_ADDRESS" %}}
388-
> ```yaml
389-
> # compose.yaml
390-
> services:
391-
> influxdb3-{{< product-key >}}:
392-
> container_name: influxdb3-{{< product-key >}}
393-
> image: influxdb:3-{{< product-key >}}
394-
> ports:
395-
> - 8181:8181
396-
> command:
397-
> - influxdb3
398-
> - serve
399-
> - --node-id=node0
400-
> - --object-store=file
401-
> - --data-dir=/var/lib/influxdb3
402-
> - --plugins-dir=/var/lib/influxdb3-plugins
403-
environment:
404-
> - INFLUXDB3_LICENSE_EMAIL=${EMAIL_ADDRESS}
405-
> ```
406-
> {{% /code-placeholders %}}
407-
> {{% code-placeholder-key %}}`EMAIL_ADDRESS`{{% /code-placeholder-key %}} is
408-
> the email you want to associate with the license. This example shows how
409-
> to reference a variable in your `.env` file.
375+
> To generate the trial or home license in Docker, bypass the email prompt.
376+
> The first time you start a new instance, provide your email address with the
377+
> `--license-email` option or the `INFLUXDB3_LICENSE_EMAIL` environment variable.
410378
>
411-
> _Currently, if you use the prompt to enter your email address, a bug may
379+
> _Currently, if you use Docker and enter your email address in the prompt, a bug may
412380
> prevent the container from generating the license ._
413381
>
414-
> For more information, see [Manage your InfluxDB 3 Enterprise license](/influxdb3/enterprise/admin/license/).
382+
> For more information, see [the Docker Compose example](/influxdb3/enterprise/admin/license/?t=Docker+compose#start-the-server-with-your-license-email).
415383
{{% /show-in %}}
416384

417385
> [!Tip]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Include the following:
152152
- `--database` option that identifies the target database
153153
- `--token` option that specifies the token to use _(unless the `INFLUXDB3_AUTH_TOKEN`
154154
environment variable is already set)_
155-
- Quoted line protocol data via standard input (stdin) or a file
155+
- Quoted line protocol data via standard input (stdin)
156156

157157
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
158158
```bash

0 commit comments

Comments
 (0)