forked from influxdata/docs-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename GS and add new Cloud GS (addresses influxdata#2124) (influxdat…
…a#2413) * Rename old GS (addresses influxdata#2124 ) * Update install.md * Add GS * Update get-started.md * Update get-started.md * Update get-started.md * Remove alia * Fix cloud menu * Update content/influxdb/cloud/get-started.md Co-authored-by: kelseiv <[email protected]> * Update content/influxdb/cloud/get-started.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/get-started.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/sign-up.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/sign-up.md Co-authored-by: kelseiv <[email protected]> * Update content/influxdb/cloud/get-started.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/get-started.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/get-started.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/sign-up.md Co-authored-by: Scott Anderson <[email protected]> * Address PR feedback * Revert changes to oss GS * Update content/influxdb/cloud/sign-up.md Co-authored-by: kelseiv <[email protected]> * Update content/influxdb/cloud/sign-up.md Co-authored-by: kelseiv <[email protected]> * Update content/influxdb/cloud/sign-up.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/sign-up.md Co-authored-by: Scott Anderson <[email protected]> * Update content/influxdb/cloud/sign-up.md Co-authored-by: Scott Anderson <[email protected]> * Update intro * Update content/influxdb/cloud/sign-up.md Co-authored-by: Scott Anderson <[email protected]> * Delete package-lock.json * Address PR feedback * Add back changes to install doc * Update content/influxdb/cloud/sign-up.md Co-authored-by: Scott Anderson <[email protected]> Co-authored-by: kelseiv <[email protected]> Co-authored-by: Scott Anderson <[email protected]>
- Loading branch information
3 people
authored
May 12, 2021
1 parent
c227d2e
commit 6aa2475
Showing
5 changed files
with
308 additions
and
270 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,299 +1,75 @@ | ||
| --- | ||
| title: Get started with InfluxDB Cloud | ||
| description: > | ||
| InfluxDB Cloud is a fully managed and hosted version of InfluxDB v2.0, the time series | ||
| platform purpose-built to collect, store, process and visualize metrics and events. | ||
| Get started with InfluxDB Cloud by querying and visualizing demo data in InfluxDB Notebooks. | ||
| menu: | ||
| influxdb_cloud: | ||
| name: Get started | ||
| weight: 2 | ||
| influxdb/cloud/tags: [get-started, install] | ||
| aliases: | ||
| - /influxdb/v2.0/cloud/get-started | ||
| weight: 2 | ||
| influxdb/cloud/tags: [get-started, install] | ||
| --- | ||
|
|
||
| InfluxDB Cloud is a fully managed and hosted version of InfluxDB v2.0, the time series | ||
| platform purpose-built to collect, store, process and visualize metrics and events. | ||
|
|
||
| _See [Differences between InfluxDB Cloud and InfluxDB OSS](#differences-between-influxdb-cloud-and-influxdb-oss)._ | ||
|
|
||
| ## Start for free | ||
|
|
||
| Start using {{< cloud-name >}} at no cost with the [Free Plan](/influxdb/cloud/account-management/pricing-plans/#free-plan). | ||
| Use it as much and as long as you like within the plan's rate-limits. | ||
| Limits are designed to let you monitor 5-10 sensors, stacks or servers comfortably. | ||
|
|
||
| ## Sign up | ||
|
|
||
| 1. Choose one of the following: | ||
|
|
||
| #### Subscribe through InfluxData | ||
|
|
||
| To subscribe to an InfluxDB Cloud **Free Plan** through InfluxData, | ||
| go to [InfluxDB Cloud](https://cloud2.influxdata.com/). | ||
|
|
||
| - To use social sign-on, click **Google** or **Microsoft**. Note that social sign-on does not support email aliases. | ||
| - Sign up with email by entering your name, email address, and password, then click **Create Account**. | ||
|
|
||
| If you originally signed up with email but want to enable social sign-on, you can do so by logging in through your cloud provider as long as you use the same email address. | ||
|
|
||
| #### **Subscribe through a cloud provider** | ||
| To subscribe to an InfluxDB Cloud **Usage-Based** plan and pay through your | ||
| **Amazon Web Services (AWS)**, **Microsoft Azure**, or **Google Cloud Platform (GCP)** account: | ||
|
|
||
| - **AWS** | ||
| Sign in to AWS, navigate to the [InfluxDB Cloud product on AWS Marketplace](https://aws.amazon.com/marketplace/pp/B08234JZPS/?href=_ptnr_web_docs_gettingstarted), | ||
| and follow the prompts to subscribe. After you click **Set Up Your Account**, | ||
| enter your credentials, and then click **Start Now**. | ||
| All usage charges will be paid through the subscribed AWS account. | ||
|
|
||
| - **Microsoft** | ||
| Sign in to Microsoft Azure, navigate to the [InfluxDB Cloud product on Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/influxdata.influxdb-cloud?ocid=iflxdbcloud_influxdata_docs_gettingstarted), | ||
| and follow the prompts to subscribe. After you click **Set Up Your Account**, | ||
| enter your credentials, and then click **Start Now**. | ||
| All usage charges will be paid through the subscribed Microsoft account. | ||
|
|
||
| - **GCP** | ||
| Sign in to GCP, navigate to the [InfluxDB Cloud product on GCP Marketplace](https://console.cloud.google.com/marketplace/details/influxdata-public/cloud2-gcp-marketplace-prod?utm_campaign=influxdb-cloud&utm_medium=docs&utm_source=influxdata), | ||
| and follow the prompts to subscribe. After you click **Set Up Your Account**, | ||
| enter your credentials, and then click **Start Now**. | ||
| All usage charges will be paid through the subscribed GCP account. | ||
|
|
||
| {{%note%}} | ||
| Currently, we do **not support** using an existing InfluxDB Cloud account to sign up for an InfluxDB Cloud plan through AWS, Microsoft, or GCP Marketplaces. | ||
| {{%/note%}} | ||
|
|
||
| 2. If you signed up with your email address, InfluxDB Cloud requires email verification to complete the sign up process. | ||
| Verify your email address by opening the email sent to the address you provided and clicking **Verify Your Email**. | ||
| 3. (If you subscribed through InfluxData) Choose your cloud provider. | ||
| 4. Select a provider and region for your {{< cloud-name >}} instance. The following are available: | ||
|
|
||
| {{< cloud_regions type="list" >}} | ||
|
|
||
| _To suggest regions to add, click **Let us know** under Regions._ | ||
| 5. Enter your company name. | ||
| 6. (If you subscribed through InfluxData) Review the terms of the agreement, and then select **I have viewed and agree to InfluxDB Cloud Services Subscription Agreement and InfluxData Global Data Processing Agreement**. | ||
| For details on the agreements, see the [InfluxDB Cloud: Services Subscription Agreement](https://www.influxdata.com/legal/terms-of-use/) and the [InfluxData Global Data Processing Agreement](https://www.influxdata.com/legal/influxdata-global-data-processing-agreement/). | ||
|
|
||
| 7. Click **Continue**, and then choose your plan: | ||
| - To upgrade to a Usage-Based plan, click **Upgrade Now**, set your limits (you may opt to receive an email when your usage exceeds the amount you enter in the **Limit ($1 minimum)** field). Next, enter your payment information and billing address, and then click **Upgrade**. A Ready To Rock confirmation appears; click **Start building your team**. Your plan will be upgraded and {{< cloud-name >}} opens with a default organization and bucket (both created from your email address). To review your usage and billing details at any time, see how to [access billing details](/influxdb/cloud/account-management/billing/#access-billing-details). | ||
| - To keep the free plan, click **Keep**. {{< cloud-name >}} opens with a default organization and bucket (both created from your email address). _To update organization and bucket names, see [Update an organization](/influxdb/cloud/organizations/update-org/) | ||
| and [Update a bucket](/influxdb/cloud/organizations/buckets/update-bucket/#update-a-buckets-name-in-the-influxdb-ui)._ | ||
| - To upgrade to an Annual plan, click **Contact Sales**, enter your information, and then click **Send**. Our team will contact you as soon as possible. | ||
|
|
||
| ## (Optional) Download, install, and use the influx CLI | ||
|
|
||
| To use the `influx` CLI to manage and interact with your InfluxDB Cloud instance, complete the following steps: | ||
|
|
||
| {{< tabs-wrapper >}} | ||
| {{% tabs %}} | ||
| [macOS](#) | ||
| [Linux](#) | ||
| {{% /tabs %}} | ||
|
|
||
| <!-------------------------------- BEGIN macOS --------------------------------> | ||
| {{% tab-content %}} | ||
|
|
||
| #### Step 1: Download influx CLI for macOS | ||
|
|
||
| Click the following button to download and install `influx` CLI for macOS. | ||
|
|
||
| <a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.0.6-darwin-amd64.tar.gz" download>influx CLI (macOS)</a> | ||
|
|
||
| #### Step 2: Unpackage the influx binary | ||
|
|
||
| **Note:** The commands below are examples. Adjust the file names, paths, and utilities to your own needs. | ||
|
|
||
| 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](https://www.iterm2.com/)**: | ||
|
|
||
| ```sh | ||
| # Unpackage contents to the current working directory | ||
| tar zxvf ~/Downloads/influxdb2-client-2.0.6-darwin-amd64.tar.gz | ||
| ``` | ||
|
|
||
| #### Step 3: (Optional) Place the binary in your $PATH | ||
|
|
||
| If you choose, you can place `influx` in your `$PATH` or you can | ||
| prefix the executable with `./` to run in place. If the binary is on your $PATH, you can run `influx` from any directory. Otherwise, you must specify the location of the CLI (for example, `./influx`or `path/to/influx`). | ||
|
|
||
| **Note:** If you have the 1.x binary on your $PATH, moving the 2.0 binary to your $PATH will overwrite the 1.x binary because they have the same name. | ||
|
|
||
| ```sh | ||
| # Copy the influx binary to your $PATH | ||
| sudo cp influxdb2-client-2.0.6-darwin-amd64/influx /usr/local/bin/ | ||
| ``` | ||
|
|
||
| {{% note %}} | ||
| If you rename the binary, all references to `influx` in this documentation refer to the renamed binary. | ||
| {{% /note %}} | ||
|
|
||
| #### Step 4: (macOS Catalina only) Authorize InfluxDB binaries | ||
|
|
||
| If running `influx` on macOS Catalina, you must manually authorize the | ||
| `influx` binary in the **Security & Privacy** section of **System Preferences**. | ||
|
|
||
| #### Step 5: Set up a configuration profile | ||
|
|
||
| To avoid having to pass your InfluxDB [authentication token](/influxdb/cloud/security/tokens/) with each `influx` command, set up a configuration profile that stores your credentials. | ||
|
|
||
| In a terminal, run the following command: | ||
|
|
||
| ```sh | ||
| # Set up a configuration profile | ||
| influx config create -n default \ | ||
| -u https://cloud2.influxdata.com \ | ||
| -o example-org \ | ||
| -t mySuP3rS3cr3tT0keN \ | ||
| -a | ||
| ``` | ||
|
|
||
| This configures a new profile named `default` and makes the profile active so your `influx` CLI commands run against this instance. | ||
| For more detail, see [influx config](/influxdb/cloud/reference/cli/influx/config/). | ||
|
|
||
| #### Step 6: Learn `influx` CLI commands | ||
|
|
||
| To see all available `influx` commands, type `influx -h` or check out [influx - InfluxDB command line interface](/influxdb/cloud/reference/cli/influx/). | ||
|
|
||
| {{% /tab-content %}} | ||
| <!--------------------------------- END macOS ---------------------------------> | ||
|
|
||
| <!-------------------------------- BEGIN Linux --------------------------------> | ||
| {{% tab-content %}} | ||
|
|
||
| #### Step 1: Download influx CLI for Linux | ||
|
|
||
| Click one of the following buttons to download and install the `influx` CLI appropriate for your chipset. | ||
|
|
||
| <a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.0.6-linux-amd64.tar.gz" download >influx CLI (amd64)</a> | ||
| <a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.0.6-linux-arm64.tar.gz" download >influx CLI (arm)</a> | ||
|
|
||
| #### Step 2: Unpackage the influx binary | ||
|
|
||
| **Note:** The commands below are examples. Adjust the file names, paths, and utilities to your own needs. | ||
|
|
||
| ```sh | ||
| # Unpackage contents to the current working directory | ||
| tar xvfz influxdb-client-2.0.6-linux-amd64.tar.gz | ||
| ``` | ||
|
|
||
| #### Step 3: (Optional) Place the binary in your $PATH | ||
|
|
||
| If you choose, you can place `influx` in your `$PATH` or you can | ||
| prefix the executable with `./` to run in place. If the binary is on your $PATH, you can run `influx` from any directory. Otherwise, you must specify the location of the CLI (for example, `./influx`or `path/to/influx`). | ||
|
|
||
| **Note:** If you have the 1.x binary on your $PATH, moving the 2.0 binary to your $PATH will overwrite the 1.x binary because they have the same name. | ||
|
|
||
| ```sh | ||
| # Copy the influx and influxd binary to your $PATH | ||
| sudo cp influxdb-client-2.0.6-linux-amd64/influx /usr/local/bin/ | ||
| ``` | ||
|
|
||
| {{% note %}} | ||
| If you rename the binary, all references to `influx` in this documentation refer to the renamed binary. | ||
| {{% /note %}} | ||
|
|
||
| #### Step 4: Set up a configuration profile | ||
|
|
||
| To avoid having to pass your InfluxDB [authentication token](/influxdb/cloud/security/tokens/) with each `influx` command, set up a configuration profile that stores your credentials. | ||
|
|
||
| In a terminal, run the following command: | ||
|
|
||
| ```sh | ||
| # Set up a configuration profile | ||
| influx config create -n default \ | ||
| -u https://cloud2.influxdata.com \ | ||
| -o example-org \ | ||
| -t mySuP3rS3cr3tT0keN \ | ||
| -a | ||
| ``` | ||
|
|
||
| This configures a new profile named `default` and makes the profile active so your `influx` CLI commands run against this instance. | ||
| For more detail, see [influx config](/influxdb/cloud/reference/cli/influx/config/). | ||
|
|
||
| #### Step 5: Learn `influx` CLI commands | ||
|
|
||
|
|
||
| {{% /tab-content %}} | ||
| <!--------------------------------- END Linux ---------------------------------> | ||
|
|
||
| {{< /tabs-wrapper >}} | ||
|
|
||
| ## Sign in | ||
|
|
||
| Sign in to [InfluxDB Cloud](https://cloud2.influxdata.com) using your email address and password. | ||
|
|
||
| <a class="btn" href="https://cloud2.influxdata.com">Sign in to InfluxDB Cloud now</a> | ||
|
|
||
| ## Start working with your time series data | ||
| After you've [signed up for InfluxDB Cloud](/influxdb/cloud/sign-up/), you're ready to start writing, querying, and visualizing data. | ||
|
|
||
| ### Collect and write data | ||
| To get started working in Cloud, we recommend using demo data and notebooks. | ||
|
|
||
| Collect and write data to InfluxDB using the Telegraf plugins, the InfluxDB v2 API, the `influx` | ||
| command line interface (CLI), the InfluxDB UI (the user interface for InfluxDB Cloud), or the InfluxDB v2 API client libraries. | ||
| ## Add demo data | ||
|
|
||
| #### Use Telegraf | ||
| This example uses InfluxDB Cloud's Website Monitoring demo data bucket. To add the demo data bucket: | ||
|
|
||
| Use Telegraf to quickly write data to {{< cloud-name >}}. | ||
| Create new Telegraf configurations automatically in the InfluxDB UI, or manually update an | ||
| existing Telegraf configuration to send data to your {{< cloud-name "short" >}} instance. | ||
| 1. In the navigation menu on the left, click **Data (Load Data)** > **Buckets**. | ||
|
|
||
| For details, see [Automatically configure Telegraf](/influxdb/cloud/write-data/no-code/use-telegraf/auto-config/) | ||
| and [Manually update Telegraf configurations](/influxdb/cloud/write-data/no-code/use-telegraf/manual-config/). | ||
| {{< nav-icon "data" >}} | ||
|
|
||
| #### API, CLI, and client libraries | ||
| 2. Click **{{< icon "plus" >}} Add Demo Data**, and then select the **Website Monitoring** bucket. | ||
| 3. The Demo Data bucket appears in your list of buckets. | ||
|
|
||
| For information about using the InfluxDB v2 API, `influx` CLI, and client libraries to write data, | ||
| see [Write data to InfluxDB](/influxdb/cloud/write-data/). | ||
| ## Select metrics | ||
|
|
||
| #### Demo data | ||
| Now that we've added the demo data bucket, we're ready to create our notebook. | ||
|
|
||
| **{{< cloud-name "short" >}}** lets you [add a demo data bucket](/influxdb/cloud/reference/sample-data/#influxdb-cloud-demo-data) | ||
| for quick, **free** access to time series data. | ||
| 1. In the navigation menu on the left, click **Notebooks**. | ||
|
|
||
| ### Query data | ||
| {{< nav-icon "notebooks" >}} | ||
| 2. Click **+Create Notebook**. | ||
| 3. Enter a name for your notebook in the **Name this notebook** field. | ||
| 4. By default, a **Metric Selector** and **Visualization** cell appear (see [Cell types](#cell-types) below for details.) | ||
| 5. In the **Metric Selector** cell, click the **Select a bucket** dropdown and choose **Website Monitoring Bucket**. | ||
|
|
||
| Query data using Flux, the UI, and the `influx` command line interface. | ||
| See [Query data](/influxdb/cloud/query-data/). | ||
| {{< img-hd src="/img/influxdb/cloud-gs-select-bucket.png" alt="Select bucket" />}} | ||
|
|
||
| ### Process data | ||
| A list of measurements, fields, and tags for the Website Monitoring bucket appear. | ||
|
|
||
| Use InfluxDB tasks to process and downsample data. See [Process data](/influxdb/cloud/process-data/). | ||
| 6. For this example, click the `response_time` field. | ||
| 7. Click **Preview** to preview the raw response time data in a table. | ||
|
|
||
| ### Visualize data | ||
| ## Visualize data | ||
|
|
||
| Build custom dashboards to visualize your data. | ||
| See [Visualize data](/influxdb/cloud/visualize-data/). | ||
| Next, we'll make it easier to visualize the raw data by viewing it in a graph. | ||
|
|
||
| ### Monitor and alert | ||
| 1. By default, a visualization cell appears below your initial metric selector cell showing the mean `response_time` values on a graph: | ||
| 2. Use the function dropdown menu to view different functions to apply to your data. For this response time data, the mean function is a good fit. | ||
| 3. Use the visualization type dropdown to view different visualization types available. | ||
| For a complete list of options, see [Visualization types](/influxdb/cloud/visualize-data/visualization-types/). | ||
| 4. Click the gear icon ({{< icon "gear" >}}) to edit specific settings for the visualization type, such as colors, orientation, and labels. | ||
|
|
||
| Monitor your data and sends alerts based on specified logic. | ||
| See [Monitor and alert](/influxdb/cloud/monitor-alert/). | ||
| ## Process data | ||
|
|
||
| ## Differences between InfluxDB Cloud and InfluxDB OSS | ||
| A common processing task is downsampling data to view it at different levels of granularity and reduce overall data disk usage over time. The following steps use a Flux script to downsample the website monitoring sample data to every 12 hours. | ||
|
|
||
| {{< cloud-name >}} is API-compatible and functionally compatible with InfluxDB OSS 2.0. | ||
| The primary differences between InfluxDB OSS 2.0 and InfluxDB Cloud are: | ||
| 1. Click **+** to add a cell, then select **Transform > Downsample**. | ||
| 2. In the **Apply aggregate** field, select **mean**. | ||
| 3. In the **Every Window Period** field, enter a value. For this example, we'll use `12h`. | ||
| 4. Click **Preview** to view the downsampled data. | ||
|
|
||
| - [InfluxDB scrapers](/influxdb/v2.0/write-data/no-code/scrape-data/) that collect data from specified | ||
| targets are not available in {{< cloud-name "short" >}}. | ||
| - {{< cloud-name "short" >}} instances are currently limited to a single organization. | ||
| ## Output to a new bucket and export as a task | ||
|
|
||
| #### New features in InfluxDB Cloud | ||
| After processing, send the downsampled data to a new bucket to store and view it. You can write it to the bucket a single time, or export it as a task, which is a scheduled Flux script, for it write to the bucket continuously. | ||
|
|
||
| - **Free Plan (rate-limited)**: Skip downloading and installing InfluxDB OSS 2.0 and | ||
| jump into exploring InfluxDB Cloud technology. | ||
| The Free Plan is designed for getting started with InfluxDB and for small hobby projects. | ||
| - **Flux support**: [Flux](/influxdb/cloud/query-data/get-started/) is a standalone data | ||
| scripting and query language that increases productivity and code reuse. | ||
| It is the primary language for working with data within InfluxDB Cloud. | ||
| Flux can be used with other data sources as well, letting you work with data where it resides. | ||
| - **Unified API**: Everything in InfluxDB (ingest, query, storage, and visualization) | ||
| is now accessible using a unified [InfluxDB v2 API](/influxdb/cloud/reference/api/) that | ||
| enables seamless movement between open source and cloud. | ||
| - **Integrated visualization and dashboards**: Based on the pioneering Chronograf project, | ||
| the new user interface (InfluxDB UI) offers quick and effortless onboarding, | ||
| richer user experiences, and significantly quicker results. | ||
| - **Usage-based pricing**: The [Usage-based Plan](/influxdb/cloud/account-management/pricing-plans/#usage-based-plan) | ||
| offers more flexibility and ensures that you only pay for what you use. | ||
| 1. Click **+** to add a cell, then select an **Output to Bucket** cell. | ||
| 2. In the **Choose a bucket** dropdown, choose **+Create a Bucket**. | ||
| 3. Enter a name for your bucket, such as Website monitoring downsampled, and click **Create**. | ||
| 4. Click **Run** from the **Preview** dropdown list to run the notebook and write to the output bucket a single time. | ||
| 5. To write continuously, click **Export as Task** in the upper right corner of the **Output to Bucket** cell. For details about working with tasks, see [Manage tasks](/influxdb/cloud/process-data/manage-tasks/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.