Skip to content

Commit 1da94dc

Browse files
committed
chore(influxdb3): Install: cleanup, remove Docker compose
1 parent 87f2ccc commit 1da94dc

File tree

1 file changed

+59
-149
lines changed

1 file changed

+59
-149
lines changed

content/shared/influxdb3/install.md

Lines changed: 59 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries)
55
- [Docker image](#docker-image)
66

7+
{{% show-in "enterprise" %}}
8+
> [!Note]
9+
> For information about setting up a multi-node {{% product-name %}} cluster,
10+
> see [Create a multi-node cluster](/influxdb3/enterprise/install/multi-server/).
11+
{{% /show-in %}}
12+
713
## System Requirements
814

915
#### Operating system
@@ -21,119 +27,69 @@ Azure Blob Storage, and Google Cloud Storage.
2127
You can also use many local object storage implementations that provide an
2228
S3-compatible API, such as [Minio](https://min.io/).
2329

24-
## Quick install
30+
## Install {{% product-name %}}
2531

26-
Use the InfluxDB 3 quick install script to install {{< product-name >}} on
27-
**Linux** and **macOS**.
32+
{{% product-name %}} runs on **Linux**, **macOS**, and **Windows**.
2833

29-
> [!Important]
30-
> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries).
34+
Choose one of the following methods to install {{% product-name %}}:
3135

32-
1. Use the following command to download and install the appropriate
33-
{{< product-name >}} package on your local machine:
34-
{{% show-in "enterprise" %}}
35-
<!--pytest.mark.skip-->
36-
```bash
37-
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
38-
&& sh install_influxdb3.sh {{% product-key %}}
39-
```
40-
{{% /show-in %}}
41-
{{% show-in "core" %}}
42-
<!--pytest.mark.skip-->
43-
```bash
44-
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
45-
&& sh install_influxdb3.sh
46-
```
47-
{{% /show-in %}}
36+
- [Quick install for Linux and macOS](#quick-install-for-linux-and-macos)
37+
- [Download and install the latest build artifacts](#download-and-install-the-latest-build-artifacts)
38+
- [Pull the Docker image](#pull-the-docker-image)
4839

49-
2. Verify that installation completed successfully:
40+
### Quick install for Linux and macOS
5041

51-
```bash
52-
influxdb3 --version
53-
```
42+
To install {{% product-name %}} on **Linux** or **macOS**, download and run the quick
43+
installer script for {{% product-name %}}--for example, using [`curl`](https://curl.se/)
44+
to download the script:
5445

55-
> [!Note]
56-
>
57-
> #### influxdb3 not found
58-
>
59-
> If your system can't locate your `influxdb3` binary, `source` your
60-
> current shell configuration file (`.bashrc`, `.zshrc`, etc.).
61-
>
62-
> {{< code-tabs-wrapper >}}
63-
{{% code-tabs %}}
64-
[.bashrc](#)
65-
[.zshrc](#)
66-
{{% /code-tabs %}}
67-
{{% code-tab-content %}}
68-
```bash
69-
source ~/.bashrc
70-
```
71-
{{% /code-tab-content %}}
72-
{{% code-tab-content %}}
7346
<!--pytest.mark.skip-->
7447
```bash
75-
source ~/.zshrc
48+
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
49+
&& sh install_influxdb3.sh {{% show-in "enterprise" %}}enterprise{{% /show-in %}}
7650
```
77-
{{% /code-tab-content %}}
78-
{{< /code-tabs-wrapper >}}
7951

80-
## Download {{% product-name %}} binaries
52+
> [!Note]
53+
> The quick installer script is updated with each {{% product-name %}} release,
54+
> so it always installs the latest version.
55+
56+
### Download and install the latest build artifacts
8157

82-
{{< tabs-wrapper >}}
83-
{{% tabs %}}
84-
[Linux](#)
85-
[macOS](#)
86-
[Windows](#)
87-
{{% /tabs %}}
88-
{{% tab-content %}}
58+
You can also download and install [{{% product-name %}} build artifacts](/influxdb3/enterprise/install/#download-influxdb-3-enterprise-binaries) directly:
8959

90-
<!-------------------------------- BEGIN LINUX -------------------------------->
60+
{{< expand-wrapper >}}
61+
{{% expand "Linux binaries" %}}
9162

92-
- [{{< product-name >}} • Linux (AMD64, x86_64) GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
63+
- [Linux | AMD64 (x86_64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
9364
9465
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256)
95-
96-
- [{{< product-name >}} • Linux (ARM64, AArch64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
66+
- [Linux | ARM64 (AArch64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
9767
9868
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256)
9969

100-
<!--------------------------------- END LINUX --------------------------------->
101-
102-
{{% /tab-content %}}
103-
{{% tab-content %}}
104-
105-
<!-------------------------------- BEGIN MACOS -------------------------------->
70+
{{% /expand %}}
71+
{{% expand "macOS binaries" %}}
10672

107-
- [{{< product-name >}} • macOS (Silicon, ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
73+
- [macOS | Silicon (ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
10874
10975
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256)
11076

11177
> [!Note]
11278
> macOS Intel builds are coming soon.
11379
114-
<!--------------------------------- END MACOS --------------------------------->
80+
{{% /expand %}}
81+
{{% expand "Windows binaries" %}}
11582

116-
{{% /tab-content %}}
117-
{{% tab-content %}}
83+
- [Windows (AMD64, x86_64) binary](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
84+
85+
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
11886

119-
<!------------------------------- BEGIN WINDOWS ------------------------------->
87+
{{% /expand %}}
88+
{{< /expand-wrapper >}}
12089

121-
- [{{< product-name >}} • Windows (AMD64, x86_64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
122-
123-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
124-
125-
<!-------------------------------- END WINDOWS -------------------------------->
126-
127-
{{% /tab-content %}}
128-
{{< /tabs-wrapper >}}
129-
130-
## Docker image
131-
132-
Use the `influxdb:3-{{< product-key >}}` Docker image to deploy {{< product-name >}} in a
133-
Docker container.
134-
The image is available for x86_64 (AMD64) and ARM64 architectures.
90+
### Pull the Docker image
13591

136-
### Use Docker CLI
92+
Run the following command to pull the [`influxdb:3-{{< product-key >}}` image](https://hub.docker.com/_/influxdb/tags?tag=3-{{< product-key >}}&name=3-{{< product-key >}}), available for x86_64 (AMD64) and ARM64 architectures:
13793

13894
<!--pytest.mark.skip-->
13995
```bash
@@ -142,6 +98,8 @@ docker pull influxdb:3-{{< product-key >}}
14298

14399
Docker automatically pulls the appropriate image for your system architecture.
144100

101+
{{< expand-wrapper >}}
102+
{{% expand "Pull for a specific system architecture" %}}
145103
To specify the system architecture, use platform-specific tags--for example:
146104

147105
```bash
@@ -157,79 +115,31 @@ docker pull \
157115
--platform linux/arm64 \
158116
influxdb:3-{{< product-key >}}
159117
```
118+
{{% /expand %}}
119+
{{< /expand-wrapper >}}
160120

161-
> [!Note]
162-
> The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections.
163-
> To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/).
164121

165-
### Use Docker Compose
122+
### Verify the installation
166123

167-
{{% show-in "enterprise" %}}
168-
1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}.
169-
To generate a trial or at-home license for {{% product-name %}} when using Docker, you must pass the `--license-email` option or the `INFLUXDB3_LICENSE_EMAIL` environment variable the first time you start the server--for example:
170-
171-
```yaml
172-
# compose.yaml
173-
services:
174-
influxdb3-{{< product-key >}}:
175-
container_name: influxdb3-{{< product-key >}}
176-
image: influxdb:3-{{< product-key >}}
177-
ports:
178-
- 8181:8181
179-
command:
180-
- influxdb3
181-
- serve
182-
- --node-id=node0
183-
- --cluster-id=cluster0
184-
- --object-store=file
185-
- --data-dir=/var/lib/influxdb3
186-
- --plugins-dir=/var/lib/influxdb3-plugins
187-
- --license-email=${INFLUXDB3_LICENSE_EMAIL}
188-
```
189-
{{% /show-in %}}
190-
{{% show-in "core" %}}
191-
1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example:
192-
193-
```yaml
194-
# compose.yaml
195-
services:
196-
influxdb3-{{< product-key >}}:
197-
container_name: influxdb3-{{< product-key >}}
198-
image: influxdb:3-{{< product-key >}}
199-
ports:
200-
- 8181:8181
201-
command:
202-
- influxdb3
203-
- serve
204-
- --node-id=node0
205-
- --object-store=file
206-
- --data-dir=/var/lib/influxdb3
207-
- --plugins-dir=/var/lib/influxdb3-plugins
208-
```
209-
{{% /show-in %}}
124+
After installing {{% product-name %}}, enter the following command to verify
125+
that it installed successfully:
210126

211-
2. Use the Docker Compose CLI to start the server.
127+
```bash
128+
influxdb3 --version
129+
```
212130

213-
Optional: to make sure you have the latest version of the image before you
214-
start the server, run `docker compose pull`.
131+
If your system doesn't locate `influxdb3`, then `source` the configuration file (for example, .bashrc, .zshrc) for your shell--for example:
215132

216-
<!--pytest.mark.skip-->
217-
```bash
218-
docker compose pull && docker compose run influxdb3-{{< product-key >}}
219-
```
133+
<!--pytest.mark.skip-->
134+
```zsh
135+
source ~/.zshrc
136+
```
220137

138+
{{% show-in "enterprise" %}}
221139
> [!Note]
222-
> #### Stopping an InfluxDB 3 container
223-
>
224-
> To stop a running InfluxDB 3 container, find and terminate the process or container--for example:
225-
>
226-
> <!--pytest.mark.skip-->
227-
> ```bash
228-
> docker container ls --filter "name=influxdb3"
229-
> docker kill <CONTAINER_ID>
230-
> ```
231-
>
232-
> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container.
140+
> For information about setting up a multi-node {{% product-name %}} cluster,
141+
> see [Create a multi-node cluster](/influxdb3/enterprise/install/multi-server/).
142+
{{% /show-in %}}
233143

234144
{{% show-in "enterprise" %}}
235145
{{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}}

0 commit comments

Comments
 (0)