Skip to content

Commit 356bfc3

Browse files
committed
WIP restructuring monolith getting started
1 parent f75719e commit 356bfc3

File tree

5 files changed

+87
-97
lines changed

5 files changed

+87
-97
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Set up InfluxDB 3 Core
3+
description: >
4+
....
5+
menu:
6+
influxdb3_core:
7+
name: Set up Core
8+
parent: Get started
9+
weight: 3
10+
related:
11+
- /influxdb3/core/install/
12+
- /influxdb3/core/admin/tokens/
13+
- /influxdb3/core/reference/config-options/
14+
source: /shared/influxdb3-get-started/setup.md
15+
---
16+
17+
<!--
18+
The content of this page is at
19+
// SOURCE content/shared/influxdb3-get-started/setup.md
20+
-->

content/influxdb3/enterprise/get-started/multi-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Use a multi-server setup
33
seotitle: Use a multi-server InfluxDB 3 Enterprise setup
44
menu:
55
influxdb3_enterprise:
6-
- name: Multi-server
7-
- parent: Get started
6+
name: Multi-server
7+
parent: Get started
88
weight: 4
99
influxdb3/enterprise/tags: [cluster, multi-node, multi-server]
1010
---
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Set up InfluxDB 3 Enterprise
3+
description: >
4+
....
5+
menu:
6+
influxdb3_enterprise:
7+
name: Set up Enterprise
8+
parent: Get started
9+
weight: 3
10+
related:
11+
- /influxdb3/enterprise/install/
12+
- /influxdb3/enterprise/admin/tokens/
13+
- /influxdb3/enterprise/reference/config-options/
14+
source: /shared/influxdb3-get-started/setup.md
15+
---
16+
17+
<!--
18+
The content of this page is at
19+
// SOURCE content/shared/influxdb3-get-started/setup.md
20+
-->

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,19 @@ This tutorial covers many of the recommended tools.
6666
{{< /caption >}}
6767

6868

69+
{{< show-in "core" >}}
70+
{{< page-nav next="/influxdb3/core/get-started/setup/" nextText="Set up InfluxDB 3 Core" >}}
71+
{{< /show-in >}}
6972

73+
{{< show-in "enterprise" >}}
74+
{{< page-nav next="/influxdb3/enterprise/get-started/setup/" nextText="Set up InfluxDB 3 Enterprise" >}}
75+
{{< /show-in >}}
7076

71-
72-
77+
<!--
78+
TO-DOs
79+
- Move this to it's own management section
80+
- Learn exactly how file indexes work
81+
- Add this content to optimizing queries
7382
7483
### File index settings
7584
@@ -107,4 +116,6 @@ Replace the following placeholders with your values:
107116
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link "admin" %}}
108117
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the database to create the file index in
109118
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: the name of the table to create the file index in
110-
- {{% code-placeholder-key %}}`COLUMNS`{{% /code-placeholder-key %}}: a comma-separated list of columns to index on, for example, `host,application`
119+
- {{% code-placeholder-key %}}`COLUMNS`{{% /code-placeholder-key %}}: a comma-separated list of columns to index on, for example, `host,application`
120+
-->
121+

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

Lines changed: 31 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,49 @@
1-
### Install and startup
1+
## Install {{% product-name %}}
22

33
{{% product-name %}} runs on **Linux**, **macOS**, and **Windows**.
4-
5-
{{% show-in "enterprise" %}}
6-
{{% tabs-wrapper %}}
7-
{{% tabs %}}
8-
[Linux or macOS](#linux-or-macos)
9-
[Windows](#windows)
10-
[Docker](#docker)
11-
{{% /tabs %}}
12-
{{% tab-content %}}
13-
<!--------------- BEGIN LINUX AND MACOS -------------->
14-
To get started quickly, download and run the install script--for example, using [curl](https://curl.se/download.html):
4+
If using **Linux** or **macOS**, you can download and use the {{% product-name %}}
5+
quick installer using [curl](https://curl.se/download.html):
156

167
<!--pytest.mark.skip-->
178
```bash
189
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
19-
&& sh install_influxdb3.sh enterprise
10+
&& sh install_influxdb3.sh {{% show-in "enterprise" %}}enterprise{{% /show-in %}}
2011
```
2112

22-
Or, download and install [build artifacts](/influxdb3/enterprise/install/#download-influxdb-3-enterprise-binaries):
13+
For detailed installation instructions, including for Windows and Docker,
14+
see [Install {{% product-name %}}](/influxdb3/version/install/).
15+
16+
You can also download and install [{{% product-name %}} build artifacts](/influxdb3/enterprise/install/#download-influxdb-3-enterprise-binaries) directly:
17+
18+
{{< expand-wrapper >}}
19+
{{% expand "Linux binaries" %}}
2320

2421
- [Linux | AMD64 (x86_64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
2522
2623
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256)
2724
- [Linux | ARM64 (AArch64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
2825
2926
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256)
27+
28+
{{% /expand %}}
29+
{{% expand "macOS binaries" %}}
30+
3031
- [macOS | Silicon (ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
3132
3233
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256)
3334

3435
> [!Note]
3536
> macOS Intel builds are coming soon.
3637
37-
<!--------------- END LINUX AND MACOS -------------->
38-
{{% /tab-content %}}
39-
{{% tab-content %}}
40-
<!--------------- BEGIN WINDOWS -------------->
41-
Download and install the {{% product-name %}} [Windows (AMD64, x86_64) binary](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
38+
{{% /expand %}}
39+
{{% expand "Windows binaries" %}}
40+
41+
- [Windows (AMD64, x86_64) binary](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
4242
4343
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
44-
<!--------------- END WINDOWS -------------->
45-
{{% /tab-content %}}
46-
{{% tab-content %}}
47-
<!--------------- BEGIN DOCKER -------------->
44+
45+
{{% /expand %}}
46+
{{% expand "Docker image" %}}
4847

4948
The [`influxdb:3-enterprise` image](https://hub.docker.com/_/influxdb/tags?tag=3-core&name=3-enterprise)
5049
is available for x86_64 (AMD64) and ARM64 architectures.
@@ -55,74 +54,13 @@ Pull the image:
5554
```bash
5655
docker pull influxdb:3-enterprise
5756
```
57+
{{% /expand %}}
58+
{{< /expand-wrapper >}}
5859

59-
<!--------------- END DOCKER -------------->
60-
{{% /tab-content %}}
61-
{{% /tabs-wrapper %}}
62-
{{% /show-in %}}
63-
64-
{{% show-in "core" %}}
65-
{{% tabs-wrapper %}}
66-
{{% tabs %}}
67-
[Linux or macOS](#linux-or-macos)
68-
[Windows](#windows)
69-
[Docker](#docker)
70-
{{% /tabs %}}
71-
{{% tab-content %}}
72-
<!--------------- BEGIN LINUX AND MACOS -------------->
73-
To get started quickly, download and run the install script--for example, using [curl](https://curl.se/download.html):
74-
75-
<!--pytest.mark.skip-->
76-
```bash
77-
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
78-
&& sh install_influxdb3.sh
79-
```
80-
Or, download and install [build artifacts](/influxdb3/core/install/#download-influxdb-3-core-binaries):
81-
82-
- [Linux | AMD64 (x86_64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
83-
84-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256)
85-
- [Linux | ARM64 (AArch64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
86-
87-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256)
88-
- [macOS | Silicon (ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
89-
90-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256)
91-
92-
> [!Note]
93-
> macOS Intel builds are coming soon.
94-
95-
<!--------------- END LINUX AND MACOS -------------->
96-
{{% /tab-content %}}
97-
{{% tab-content %}}
98-
<!--------------- BEGIN WINDOWS -------------->
99-
Download and install the {{% product-name %}} [Windows (AMD64, x86_64) binary](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
100-
101-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
102-
<!--------------- END WINDOWS -------------->
103-
{{% /tab-content %}}
104-
{{% tab-content %}}
105-
<!--------------- BEGIN DOCKER -------------->
106-
The [`influxdb:3-core` image](https://hub.docker.com/_/influxdb/tags?tag=3-core&name=3-core)
107-
is available for x86_64 (AMD64) and ARM64 architectures.
108-
109-
Pull the image:
110-
111-
<!--pytest.mark.skip-->
112-
```bash
113-
docker pull influxdb:3-core
114-
```
115-
116-
<!--------------- END DOCKER -------------->
117-
{{% /tab-content %}}
118-
{{% /tabs-wrapper %}}
119-
{{% /show-in %}}
60+
### Verify the installation
12061

121-
_Build artifacts and images update with every merge into the {{% product-name %}} `main` branch._
122-
123-
#### Verify the install
124-
125-
After you have installed {{% product-name %}}, enter the following command to verify that it completed successfully:
62+
After installing {{% product-name %}}, enter the following command to verify
63+
that it installed successfully:
12664

12765
```bash
12866
influxdb3 --version
@@ -135,10 +73,11 @@ If your system doesn't locate `influxdb3`, then `source` the configuration file
13573
source ~/.zshrc
13674
```
13775

76+
## Start InfluxDB
13877

139-
#### Start InfluxDB
140-
141-
To start your InfluxDB instance, use the `influxdb3 serve` command and provide the following:
78+
Use the [`influxdb3 serve` command](/influxdb3/version/reference/cli/influxdb3/serve/)
79+
to start {{% product-name %}}.
80+
Provide the following:
14281

14382
- `--object-store`: Specifies the type of object store to use.
14483
InfluxDB supports the following: local file system (`file`), `memory`,

0 commit comments

Comments
 (0)