Merge pull request #97 from influxdata/cloud-2-beta

Cloud 2 beta docs structure and content
pull/103/head
noramullen1 2019-03-20 15:23:14 -07:00 committed by GitHub
commit a12c3eeddd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 359 additions and 46 deletions

View File

@ -62,6 +62,8 @@ weight: # Determines sort order in both the nav tree and in article lists.
draft: # If true, will not render page on build
enterprise_all: # If true, specifies the doc as a whole is specific to InfluxDB Enterprise
enterprise_some: # If true, specifies the doc includes some content specific to InfluxDB Enterprise
cloud_all: # If true, specifies the doc as a whole is specific to InfluxCloud
cloud_some: # If true, specifies the doc includes some content specific to InfluxCloud
v2.x/tags: # Tags specific to each version (replace .x" with the appropriate minor version )
```
@ -135,6 +137,59 @@ Insert enterprise-specific markdown content here.
{{% /enterprise %}}
```
#### Enterprise name
The name used to refer to InfluxData's enterprise offering is subject to change.
To facilitate easy updates in the future, use the `enterprise-name` shortcode when referencing the enterprise product.
```
This is content that references {{< enterprise-name >}}.
```
The product name is stored in `data/products.yml`
### InfluxCloud Content
Some articles are unique to InfluxCloud or at least contain some information specific to InfluxCloud.
There are frontmatter options and an cloud shortcode that help to properly identify this content.
#### All content is cloud-specific
If all content in an article is cloud-specific, set the menu in the frontmatter to `v2_0_cloud`
(change the version number for the specific version of InfluxCloud).
```yaml
menu:
v2_0_cloud:
name: Menu item name
# ...
```
The pages `parent` depends on where it fits in the hierarchy of the cloud documentation.
#### Only some content is cloud-specific
If only some content in the article is cloud-specific, set the `cloud_some` frontmatter to `true`.
```yaml
cloud_some: true
```
This will display a message at the top of page indicating some things are unique to InfluxCloud.
To format cloud-specific content, wrap it in the `{{% cloud %}}` shortcode:
```md
{{% cloud %}}
Insert Cloud-specific markdown content here.
{{% /cloud %}}
```
#### InfluxCloud name
The name used to refer to InfluxData's cloud offering is subject to change.
To facilitate easy updates in the future, use the `cloud-name` short-code when referencing the cloud product.
```
This is content that references {{< cloud-name >}}.
```
The product name is stored in `data/products.yml`
### Tabbed Content
Shortcodes are available for creating "tabbed" content (content that is changed by a users' selection).
Ther following three must be used:

View File

@ -272,7 +272,8 @@
.feedback,
.note,
.warn,
.enterprise-msg {
.enterprise-msg,
.cloud-msg {
padding: 1.65rem 2rem .1rem 2rem;
margin: 1rem 0 2rem;
border-width: 0 0 0 4px;
@ -391,44 +392,67 @@
///////////////////////////////// Enterprise /////////////////////////////////
.enterprise-msg {
border-color: $article-enterprise-base;
background: rgba($article-enterprise-base, .15);
font-style: italic;
display: flex;
p {
color: $article-enterprise-text;
}
a {
color: $article-enterprise-link;
&:hover {
color: $article-enterprise-link-hover;
}
}
div:first-child { margin-right: 1.25rem; }
}
.enterprise, .cloud {
position: relative;
padding: 0 0 .01rem 2rem;
margin-left: -2rem;
.enterprise-flag {
padding: .2rem .4rem;
background: $article-enterprise-base;
font-size: .75rem;
font-style: normal;
font-weight: bold;
color: $g20-white;
border-radius: $border-radius;
vertical-align: text-bottom;
&:before {
content: "E";
&-msg {
font-style: italic;
display: flex;
div:first-child { margin-right: 1.25rem; }
}
&-flag {
padding: .2rem .4rem;
font-size: .75rem;
font-style: normal;
font-weight: bold;
color: $g20-white;
border-radius: $border-radius;
vertical-align: text-bottom;
}
}
.enterprise {
position: relative;
padding: 0 0 .01rem 2rem;
margin-left: -2rem;
border-left: 2px solid $article-enterprise-base;
&-msg {
border-color: $article-enterprise-base;
background: rgba($article-enterprise-base, .15);
p { color: $article-enterprise-text; }
a {
color: $article-enterprise-link;
&:hover { color: $article-enterprise-link-hover; }
}
}
&-flag {
background: $article-enterprise-base;
&:before {
content: "E";
}
}
}
.enterprise-flag {
.cloud {
border-left: 2px solid $article-cloud-base;
&-msg {
border-color: $article-cloud-base;
background: rgba($article-cloud-base, .15);
p { color: $article-cloud-text; }
a {
color: $article-cloud-link;
&:hover { color: $article-cloud-link-hover; }
}
}
&-flag {
background: $article-cloud-base;
&:before {
content: "C";
}
}
}
.enterprise, .cloud {
.enterprise-flag, .cloud-flag {
position: absolute;
top: -.15rem;
left: -.68rem;
@ -695,16 +719,17 @@
blockquote,
.note,
.warn,
#enterprise-msg {
.enterprise-msg,
.cloud-msg {
padding: 1.35rem 1.25rem .1rem 1.25rem;
margin: .5rem 0 1rem;
}
.enterprise {
.enterprise, .cloud {
padding: 0 0 .01rem .85rem;
margin-left: -.85rem;
.enterprise-flag {
.enterprise-flag, .cloud-flag {
left: -.25rem;
}
}

View File

@ -105,6 +105,11 @@ $article-enterprise-text: $p-potassium !default;
$article-enterprise-link: $p-moonstone !default;
$article-enterprise-link-hover: $g20-white !default;
$article-cloud-base: $b-pool !default;
$article-cloud-text: $b-neutrino !default;
$article-cloud-link: $b-snow !default;
$article-cloud-link-hover: $g20-white !default;
// Article Tabs for tabbed content
$article-tab-text: $g12-forge !default;
$article-tab-bg: $g4-onyx !default;

View File

@ -104,6 +104,11 @@ $article-enterprise-text: $p-star;
$article-enterprise-link: $p-star;
$article-enterprise-link-hover: $b-ocean;
$article-cloud-base: $b-laser;
$article-cloud-text: $b-ocean;
$article-cloud-link: $b-ocean;
$article-cloud-link-hover: $gr-canopy;
// Article Tabs for tabbed content
$article-tab-text: $g8-storm;
$article-tab-bg: $g18-cloud;

View File

@ -0,0 +1,72 @@
---
title: Get started with InfluxCloud 2.0 Beta
description: >
Sign up for and get started with InfluxCloud 2.0 Beta.
weight: 1
menu:
v2_0_cloud:
name: Get started with InfluxCloud
---
{{< cloud-name >}} is a fully managed and hosted version of the InfluxDB 2.x API. To get started, complete the tasks below.
{{% cloud-msg %}}
The InfluxDB v2.0 alpha documentation linked to in this article also applies to {{< cloud-name "short" >}} unless otherwise specified.
{{% /cloud-msg %}}
## Sign up
{{% note %}}
Early access to {{< cloud-name >}} is limited. Apply for access [here](https://www.influxdata.com/influxcloud2beta/).
{{% /note %}}
Sign up for the InfluxCloud 2.0 Beta with the link provided in the invite email.
1. Look for an email invite from support@influxdata.com with the subject line **You've been invited to beta InfluxCloud 2.0.**
2. Click **Accept Invite** to begin the sign up process.
3. Provide an email id, password and follow the prompts to sign up for a Free Tier.
4. Select the Region and click Next to create your default organization and bucket.
{{% cloud-msg %}}
InfluxCloud 2.0 Beta is restricted to the us-west-2 region.
{{% /cloud-msg %}}
5. Once your organization and bucket are created, the usage page opens.
{{% note %}}
Currently, this page is just a mockup with no real data. This capability will be available soon.
{{% /note %}}
## Log in
Log in at [https://us-west-2-1.aws.cloud2.influxdata.com](https://us-west-2-1.aws.cloud2.influxdata.com) using the credentials created above.
## Collect data
Use Telegraf to collect and write data to {{< cloud-name >}}. Create Telegraf configurations automatically in the UI or manually configure Telegraf.
For details, see [Automatically configure Telegraf](https://v2.docs.influxdata.com/v2.0/collect-data/use-telegraf/auto-config/#create-a-telegraf-configuration) and [Manually configure Telegraf](https://v2.docs.influxdata.com/v2.0/collect-data/use-telegraf/manual-config/).
## Query and visualize data
Once you've set up InfluxCloud to collect data with Telegraf, you can do the following:
* Query data using Flux, the UI, and the `influx` command line interface. See [Query data](https://v2.docs.influxdata.com/v2.0/query-data/).
* Build custom dashboards to visualize your data. See [Visualize data](https://v2.docs.influxdata.com/v2.0/visualize-data/).
## Known issues and disabled features
The following issues currently exist in {{< cloud-name >}}:
* IDPE-2860: Additional user shows up as owner under Cloud 2 organization.
* IDPE 2868: User must not be able to delete token with an active Telegraf configuration pointed to it.
* IDPE-2869: As a Cloud 2.0 user, I cannot use any CLI tools to interact with my Cloud 2 tenant.
* IDPE-2896: Logout does not work in Cloud 2.0 UI.
* IDPE-2897: Single sign on does not work between `https://cloud2.influxdata.com` and `https://us-west-2-
1.aws.cloud2.influxdata.com`.
* [TELEGRAF-5600](https://github.com/influxdata/telegraf/issues/5600): Improve error message in Telegraf when bucket it's reporting to is not found.
* [INFLUXDB-12686](https://github.com/influxdata/influxdb/issues/12686): Unable to copy error message from UI.
* [INFLUXDB-12690](https://github.com/influxdata/influxdb/issues/12690): Impossible to change a task from `every` to `cron`.
* [INFLUXDB-12688](https://github.com/influxdata/influxdb/issues/12688): Create bucket switching between periodically and never fails to create bucket.
* [INFLUXDB-12687](https://github.com/influxdata/influxdb/issues/12687): Create org should display only for the create org permission.

View File

@ -19,6 +19,11 @@ then write the scraped data to an InfluxDB bucket.
Scrapers can collect data from any HTTP(S)-accessible endpoint that provides data
in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/).
{{% cloud-msg %}}
Scrapers are not available in {{< cloud-name "short" >}}.
{{% /cloud-msg %}}
The following articles provide information about creating and managing InfluxDB data scrapers:
{{< children >}}

View File

@ -7,6 +7,8 @@ menu:
weight: 1
#enterprise_all: true
enterprise_some: true
cloud_all: true
#cloud_some: true
draft: true
"v2.0/tags": [influxdb]
---
@ -77,6 +79,7 @@ There is a horizontal rule above and below this line.
---
{{% cloud %}}
#### Inline Styles
This is an [inline link](#). This is `inline code`.
This is an [`inline code link`](#).
@ -160,7 +163,7 @@ avg_cpu
|> yield()
//
```
{{% /cloud %}}
{{% enterprise %}}
###### This is a table

View File

@ -11,6 +11,10 @@ v2.0/tags: [get-started, install]
Get started with InfluxDB 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 InfluxCloud 2.0 Beta](/v2.0/cloud/get-started/).
{{% /cloud-msg %}}
{{< tabs-wrapper >}}
{{% tabs %}}
[macOS](#)
@ -169,7 +173,7 @@ docker exec -it influxdb /bin/bash
{{< /tabs-wrapper >}}
## Setup InfluxDB
## 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

View File

@ -12,6 +12,10 @@ weight: 101
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
to create an organization.
{{% cloud-msg %}}
You cannot currently create additional organizations in {{< cloud-name >}}. Only the default organization is available.
{{% /cloud-msg %}}
## Create an organization in the InfluxDB UI
1. Click the **Organizations** tab in the navigation bar.

8
data/products.yml Normal file
View File

@ -0,0 +1,8 @@
enterprise:
name: "InfluxDB 2.0 Enterprise"
link: "#"
cloud:
name: "InfluxCloud 2.0 Beta"
shortname: "InfluxCloud"
link: "https://www.influxdata.com/influxcloud2beta/"

View File

@ -3,8 +3,14 @@
<h1>{{ .Title }}</h1>
{{ partial "article/latest-version.html" . }}
{{ partial "article/enterprise.html" . }}
{{ partial "article/cloud.html" . }}
{{ .Content }}
{{ partial "article/tags.html" . }}
{{ partial "article/_alpha-feedback.html"}}
{{ if in .RelPermalink "/cloud/"}}
{{ partial "article/_cloud-feedback.html"}}
{{ else }}
{{ partial "article/_alpha-feedback.html"}}
{{ end }}
</article>
</div>

View File

@ -0,0 +1,7 @@
<hr/>
<div class="feedback">
<h4>InfluxCloud Bug Reports and Feedback</h4>
<p>
To provide feedback or report a bug, send an email to <a href="mailto:cloudbeta@influxdata.com?subject=InfluxCloud 2.0 Beta Feedback">cloudbeta@influxdata.com</a>.
</p>
</div>

View File

@ -0,0 +1,20 @@
{{ $cloudName := .Site.Data.products.cloud.name }}
{{ $cloudLink := .Site.Data.products.cloud.link }}
{{ if ( $.Params.cloud_all ) }}
<div class="cloud-msg" id="cloud-msg">
<p>
The features and functionality discussed on this page are unique to <a href="{{ $cloudLink }}" target="_blank">{{ $cloudName }}</a>.
</p>
</div>
{{ else if ( $.Params.cloud_some ) }}
<div class="cloud-msg" id="cloud-msg">
<div>
<span class="cloud-flag"></span>
</div>
<div>
<p>
This page includes features and functionality unique to <a href="{{ $cloudLink }}" target="_blank">{{ $cloudName }}</a>.
</p>
</div>
</div>
{{ end }}

View File

@ -1,20 +1,19 @@
{{ $enterpriseLink := "#"}}
{{ $enterpriseName := .Site.Data.products.enterprise.name }}
{{ $enterpriseLink := .Site.Data.products.enterprise.link }}
{{ if ( $.Params.enterprise_all ) }}
<div class="enterprise-msg">
<div class="enterprise-msg" id="enterprise-msg">
<p>
The features and functionality discussed on this page are unique to the Enterprise edition of InfluxDB.
<a href="{{ $enterpriseLink }}" target="_blank">Learn more about InfluxDB Enterprise</a>.
The features and functionality discussed on this page are unique to <a href="{{ $enterpriseLink }}" target="_blank">{{ $enterpriseName }}</a>.
</p>
</div>
{{ else if ( $.Params.enterprise_some ) }}
<div class="enterprise-msg">
<div class="enterprise-msg" id="enterprise-msg">
<div>
<span class="enterprise-flag"></span>
</div>
<div>
<p>
This page includes features and functionality unique to the Enterprise edition of InfluxDB.
<a href="{{ $enterpriseLink }}" target="_blank">Learn more about InfluxDB Enterprise</a>.
This page includes features and functionality unique to <a href="{{ $enterpriseLink }}" target="_blank">{{ $enterpriseName }}</a>.
</p>
</div>
</div>

View File

@ -5,10 +5,14 @@
{{ partial "header/google-analytics.html" }}
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
{{ if in .RelPermalink "/cloud/"}}
<title>{{ if .Params.seotitle }} {{ print .Params.seotitle " | " }} {{ else if .Title }} {{ print .Title " | " }}{{ end }}{{ .Site.Data.products.cloud.name }} Documentation</title>
{{ else }}
<title>{{ if .Params.seotitle }} {{ print .Params.seotitle " | " }} {{ else if .Title }} {{ print .Title " | " }} {{ end }}InfluxDB {{ if $currentVersion }}{{print $currentVersion " " }}{{ end }}Documentation</title>
{{ end }}
<meta name="description" content="{{ if .Description }}{{ .Description | markdownify | plainify }}{{else}}{{ .Summary | markdownify | plainify }}{{ end }}">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link rel="shortcut icon" href="/img/favicon.png" type="image/png">
<title>{{ if .Params.seotitle }} {{ print .Params.seotitle " | " }} {{ else if .Title }} {{ print .Title " | " }} {{ end }}InfluxDB {{ if $currentVersion }}{{print $currentVersion " " }}{{ end }}Documentation</title>
{{ partial "header/canonical.html" . }}
{{ partial "header/stylesheets.html" }}

View File

@ -99,6 +99,83 @@
</li>
{{end}}
<!-- Cloud Section -->
{{ $refMenuID := print (replaceRE "[.]" "_" $currentVersion) "_cloud" }}
<h4 class="reference">{{ .Site.Data.products.cloud.shortname }}</h4>
{{ range (index .Site.Menus $refMenuID) }}
<!-- Nested Reference Navigation -->
<li class="nav-category {{ if eq $currentPage.URL .URL }}active{{end}}">
{{ if .HasChildren }}<a href="#" class="children-toggle {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}"></a>{{ end }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ if .HasChildren }}
<ul class="children {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}">
{{ range .Children }}
<li class="nav-item {{ if eq $currentPage.URL .URL }}active{{end}}">
{{ if .HasChildren }}<a href="#" class="children-toggle {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}"></a>{{ end }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ if .HasChildren }}
<ul class="children {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}">
{{ range .Children }}
<li class="nav-item {{ if eq $currentPage.URL .URL }}active{{end}}">
{{ if .HasChildren }}<a href="#" class="children-toggle {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}"></a>{{ end }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ if .HasChildren }}
<ul class="children {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}">
{{ range .Children }}
<li class="nav-item {{ if eq $currentPage.URL .URL }}active{{end}}">
{{ if .HasChildren }}<a href="#" class="children-toggle {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}"></a>{{ end }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ if .HasChildren }}
<ul class="children {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}">
{{ range .Children }}
<li class="nav-item {{ if eq $currentPage.URL .URL }}active{{end}}">
{{ if .HasChildren }}<a href="#" class="children-toggle {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}"></a>{{ end }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ if .HasChildren }}
<ul class="children {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}">
{{ range .Children }}
<li class="nav-item {{ if eq $currentPage.URL .URL }}active{{end}}">
{{ if .HasChildren }}<a href="#" class="children-toggle {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}"></a>{{ end }}
<a href="{{ .URL }}">{{ .Name }}</a>
<!-- Begin nested block -->
{{ if .HasChildren }}
<ul class="children {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}">
{{ range .Children }}
<li class="nav-item {{ if eq $currentPage.URL .URL }}active{{end}}">
{{ if .HasChildren }}<a href="#" class="children-toggle {{ if or ($currentPage.IsMenuCurrent .Menu .) ($currentPage.HasMenuCurrent .Menu .) }}open{{end}}"></a>{{ end }}
<a href="{{ .URL }}">{{ .Name }}</a>
<!-- To add more nested layers, copy the nested block and paste it here -->
</li>
{{ end }}
</ul>
{{ end }}
<!-- End nested block -->
</li>
{{ end }}
</ul>
{{ end }}
</li>
{{ end }}
</ul>
{{ end }}
</li>
{{ end }}
</ul>
{{ end }}
</li>
{{ end }}
</ul>
{{ end }}
</li>
{{ end }}
</ul>
{{ end }}
</li>
{{end}}
<!-- Reference Section -->
{{ $refMenuID := print (replaceRE "[.]" "_" $currentVersion) "_ref" }}
<h4 class="reference">Reference</h4>

View File

@ -0,0 +1,3 @@
<div class="cloud-msg">
{{ .Inner }}
</div>

View File

@ -0,0 +1,6 @@
{{ $length := .Get 0 | default "long" }}
{{ if eq $length "long" }}
{{- .Site.Data.products.cloud.name -}}
{{ else if eq $length "short" }}
{{- .Site.Data.products.cloud.shortname -}}
{{ end }}

View File

@ -0,0 +1,4 @@
<div class="cloud">
<a class="cloud-flag" href="#cloud-msg"></a>
{{ .Inner }}
</div>

View File

@ -0,0 +1 @@
{{ .Site.Data.products.enterprise.name }}