Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/v2.0/get-started.md

11 KiB
Raw Blame History

title description menu weight v2.0/tags
Get started with InfluxDB OSS Download, install, and setup InfluxDB, creating a default organization, user, and bucket.
v2_0
name
Get started
1
get-started
install

Get started with InfluxDB OSS v2.0 by downloading InfluxDB, installing the necessary executables, and running the initial setup process.

{{% cloud-msg %}} This article describes how to get started with InfluxDB OSS. To get started with {{< cloud-name "short" >}}, see Get Started with {{< cloud-name >}}. {{% /cloud-msg %}}

{{< tabs-wrapper >}} {{% tabs %}} macOS Linux Docker Kubernetes {{% /tabs %}}

{{% tab-content %}}

Download and install InfluxDB v2.0 beta

Download InfluxDB v2.0 beta for macOS.

InfluxDB v2.0 beta (macOS)

Unpackage the InfluxDB binaries

To unpackage the downloaded archive, double click the archive file in Finder or run the following command in a macOS command prompt application such Terminal or iTerm2:

# Unpackage contents to the current working directory
tar zxvf ~/Downloads/influxdb_2.0.0-beta.7_darwin_amd64.tar.gz

(Optional) Place the binaries in your $PATH

If you choose, you can place influx and influxd in your $PATH or you can prefix the executables with ./ to run then in place.

# (Optional) Copy the influx and influxd binary to your $PATH
sudo cp influxdb_2.0.0-beta.7_darwin_amd64/{influx,influxd} /usr/local/bin/

{{% note %}} Both InfluxDB 1.x and 2.x include influx and influxd binaries. If InfluxDB 1.x binaries are already in your $PATH, run the 2.0 binaries in place or rename them before putting them in your $PATH. If you rename the binaries, all references to influx and influxd in this documentation refer to your renamed binaries. {{% /note %}}

Networking ports

By default, InfluxDB uses TCP port 9999 for client-server communication over the InfluxDB HTTP API.

Start InfluxDB

Start InfluxDB by running the influxd daemon:

influxd

{{% warn %}}

Run InfluxDB on macOS Catalina

macOS Catalina requires downloaded binaries to be signed by registered Apple developers. Currently, when you first attempt to run influxd or influx, macOS will prevent it from running. To manually authorize the InfluxDB binaries:

  1. Attempt to run the influx or influxd commands.
  2. Open System Preferences and click Security & Privacy.
  3. Under the General tab, there is a message about influxd or influx being blocked. Click Open Anyway.
  4. Repeat this process for both binaries.

We are in the process of updating our build process to ensure released binaries are signed by InfluxData. {{% /warn %}}

See the influxd documentation for information about available flags and options.

{{% note %}}

InfluxDB "phone home"

By default, InfluxDB sends telemetry data back to InfluxData. The InfluxData telemetry page provides information about what data is collected and how it is used.

To opt-out of sending telemetry data back to InfluxData, include the --reporting-disabled flag when starting influxd.

influxd --reporting-disabled

{{% /note %}}

{{% /tab-content %}}

{{% tab-content %}}

Download and install InfluxDB v2.0 beta

Download the InfluxDB v2.0 beta package appropriate for your chipset.

InfluxDB v2.0 beta (amd64) InfluxDB v2.0 beta (arm)

Place the executables in your $PATH

Unpackage the downloaded archive and place the influx and influxd executables in your system $PATH.

Note: The following commands are examples. Adjust the file names, paths, and utilities to your own needs.

# Unpackage contents to the current working directory
tar xvzf path/to/influxdb_2.0.0-beta.7_linux_amd64.tar.gz

# Copy the influx and influxd binary to your $PATH
sudo cp influxdb_2.0.0-beta.7_linux_amd64/{influx,influxd} /usr/local/bin/

{{% note %}} Both InfluxDB 1.x and 2.x include influx and influxd binaries. If InfluxDB 1.x binaries are already in your $PATH, run the 2.0 binaries in place or rename them before putting them in your $PATH. If you rename the binaries, all references to influx and influxd in this documentation refer to your renamed binaries. {{% /note %}}

Networking ports

By default, InfluxDB uses TCP port 9999 for client-server communication over the InfluxDB HTTP API.

Start InfluxDB

Start InfluxDB by running the influxd daemon:

influxd

See the influxd documentation for information about available flags and options.

{{% note %}}

InfluxDB "phone home"

By default, InfluxDB sends telemetry data back to InfluxData. The InfluxData telemetry page provides information about what data is collected and how it is used.

To opt-out of sending telemetry data back to InfluxData, include the --reporting-disabled flag when starting influxd.

influxd --reporting-disabled

{{% /note %}}

{{% /tab-content %}}

{{% tab-content %}}

Download and run InfluxDB v2.0 beta

Use docker run to download and run the InfluxDB v2.0 beta Docker image. Expose port 9999, which InfluxDB uses for client-server communication over the InfluxDB HTTP API.

docker run --name influxdb -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta

To run InfluxDB in detached mode, include the -d flag in the docker run command.

{{% note %}}

InfluxDB "phone home"

By default, InfluxDB sends telemetry data back to InfluxData. The InfluxData telemetry page provides information about what data is collected and how it is used.

To opt-out of sending telemetry data back to InfluxData, include the --reporting-disabled flag when starting the InfluxDB container.

docker run -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta --reporting-disabled

{{% /note %}}

Console into the InfluxDB Container (Optional)

To use the influx command line interface, console into the influxdb Docker container:

docker exec -it influxdb /bin/bash

{{% /tab-content %}}

{{% tab-content %}}

Install InfluxDB in a Kubernetes cluster

{{% note %}} The instructions below use Minikube, but the steps should be similar in any Kubernetes cluster. {{% /note %}}

  1. Install Minikube.

  2. Start Minikube:

    minikube start

  3. Apply the sample InfluxDB configuration by running:

    kubectl apply -f https://raw.githubusercontent.com/influxdata/docs-v2/master/static/downloads/influxdb-k8-minikube.yaml

    Always inspect YAML manifests before running kubectl apply -f <url>!

    This creates an influxdb Namespace, Service, and StatefulSet. A PersistentVolumeClaim is also created to store data written to InfluxDB.

  4. Ensure the Pod is running:

    kubectl get pods -n influxdb

  5. Ensure the Service is available:

    kubectl describe service -n influxdb influxdb

    You should see an IP address after Endpoints in the command's output.

  6. Forward port 9999 from inside the cluster to localhost:

    kubectl port-forward -n influxdb service/influxdb 9999:9999

{{% /tab-content %}}

{{< /tabs-wrapper >}}

Set up InfluxDB

The initial setup process for InfluxDB walks through creating a default organization, user, and bucket. The setup process is available in both the InfluxDB user interface (UI) and in the influx command line interface (CLI).

{{< tabs-wrapper >}} {{% tabs %}} UI Setup CLI Setup {{% /tabs %}}

{{% tab-content %}}

Set up InfluxDB through the UI

  1. With InfluxDB running, visit localhost:9999.
  2. Click Get Started

Set up your initial user

  1. Enter a Username for your initial user.
  2. Enter a Password and Confirm Password for your user.
  3. Enter your initial Organization Name.
  4. Enter your initial Bucket Name.
  5. Click Continue.

InfluxDB is now initialized with a primary user, organization, and bucket. You are ready to write or collect data.

{{% note %}}

Using the influx CLI after setting up InfluxDB through the UI

To use the influx CLI after setting up InfluxDB through the UI, use one of the following methods to provide your authentication token to the CLI:

  1. Pass your token to the influx CLI using the -t or --token flag.

  2. Set the INFLUX_TOKEN environment variable using your token.

    export INFLUX_TOKEN=oOooYourAuthTokenOoooOoOO==

  3. Store your token in ~/.influxdbv2/credentials. The content of the credentials file should be only your token.

See View tokens for information about retrieving authentication tokens. {{% /note %}}

{{% /tab-content %}}

{{% tab-content %}}

Set up InfluxDB through the influx CLI

Begin the InfluxDB setup process via the influx CLI by running:

influx setup
  1. Enter a primary username.
  2. Enter a password for your user.
  3. Confirm your password by entering it again.
  4. Enter a name for your primary organization.
  5. Enter a name for your primary bucket.
  6. Enter a retention period (in hours) for your primary bucket. Enter nothing for an infinite retention period.
  7. Confirm the details for your primary user, organization, and bucket.

InfluxDB is now initialized with a primary user, organization, and bucket. You are ready to write or collect data.

{{% note %}} To automate the setup process, use flags to provide the required information. {{% /note %}}

{{% /tab-content %}}

{{< /tabs-wrapper >}}