Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update notes and warnings in influxdb3 to use gh alert syntax #5890

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions content/influxdb3/cloud-dedicated/admin/databases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,16 @@ alt_links:
An InfluxDB database is a named location where time series data is stored.
Each InfluxDB database has a [retention period](#retention-periods).

{{% note %}}
**If coming from InfluxDB v1**, the concepts of databases and retention policies
have been combined into a single concept--database. Retention policies are no
longer part of the InfluxDB data model.
However, {{% product-name %}} does
support InfluxQL, which requires databases and retention policies.
See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).

**If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**,
_database_ and _bucket_ are synonymous.
{{% /note %}}
> [!Note]
> **If coming from InfluxDB v1**, the concepts of databases and retention policies
> have been combined into a single concept--database. Retention policies are no
> longer part of the InfluxDB data model.
> However, {{% product-name %}} does
> support InfluxQL, which requires databases and retention policies.
> See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
>
> **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**,
> _database_ and _bucket_ are synonymous.

## Retention periods

Expand Down
23 changes: 10 additions & 13 deletions content/influxdb3/cloud-dedicated/admin/databases/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,8 @@ to create a database in your {{< product-name omit=" Clustered" >}} cluster.
the time interval to partition by. Default is `%Y-%m-%d`.
- Database name _(see [Database naming restrictions](#database-naming-restrictions))_

{{% note %}}
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
{{% /note %}}
> [!Note]
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._

<!--Skip tests for database create and delete: namespaces aren't reusable-->
<!--pytest.mark.skip-->
Expand Down Expand Up @@ -232,9 +231,8 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques
the time interval to partition by. Default is `%Y-%m-%d`.
- Database name _(see [Database naming restrictions](#database-naming-restrictions))_.

{{% note %}}
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
{{% /note %}}
> [!Note]
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._

The following example shows how to use the Management API to create a database with custom partitioning:

Expand Down Expand Up @@ -343,13 +341,12 @@ For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/
{{% /tab-content %}}
{{< /tabs-wrapper >}}

{{% warn %}}

#### Partition templates can only be applied on create

You can only apply a partition template when creating a database.
You can't update a partition template on an existing database.
{{% /warn %}}
> [!Warning]
>
> #### Partition templates can only be applied on create
>
> You can only apply a partition template when creating a database.
> You can't update a partition template on an existing database.

### Database naming restrictions

Expand Down
19 changes: 9 additions & 10 deletions content/influxdb3/cloud-dedicated/admin/databases/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,15 @@ related:
Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster.

{{% warn %}}

#### Deleting a database cannot be undone

Once a database is deleted, data stored in that database cannot be recovered.

#### Cannot reuse database names

After a database is deleted, you cannot reuse the same name for a new database.
{{% /warn %}}
> [!Warning]
>
> #### Deleting a database cannot be undone
>
> Once a database is deleted, data stored in that database cannot be recovered.
>
> #### Cannot reuse database names
>
> After a database is deleted, you cannot reuse the same name for a new database.

{{< tabs-wrapper >}}
{{% tabs %}}
Expand Down
38 changes: 18 additions & 20 deletions content/influxdb3/cloud-dedicated/admin/databases/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,11 @@ Replace the following in your command:

- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/)

{{% warn %}}
#### Database names can't be updated

The `influxctl database update` command uses the database name to identify which
database to apply updates to. The database name itself can't be updated.
{{% /warn %}}
> [!Warning]
> #### Database names can't be updated
>
> The `influxctl database update` command uses the database name to identify which
> database to apply updates to. The database name itself can't be updated.

## Database attributes

Expand Down Expand Up @@ -217,20 +216,19 @@ The retention period value cannot be negative or contain whitespace.
{{% /tab-content %}}
{{< /tabs-wrapper >}}

{{% warn %}}

#### Database names can't be updated

The Management API `PATCH /api/v0/database` endpoint and
the`influxctl database update` command use the database name to identify which
database to apply updates to.
The database name itself can't be updated.

#### Partition templates can't be updated

You can only apply a partition template when creating a database.
You can't update a partition template on an existing database.
{{% /warn %}}
> [!Warning]
>
> #### Database names can't be updated
>
> The Management API `PATCH /api/v0/database` endpoint and
> the`influxctl database update` command use the database name to identify which
> database to apply updates to.
> The database name itself can't be updated.
>
> #### Partition templates can't be updated
>
> You can only apply a partition template when creating a database.
> You can't update a partition template on an existing database.

### Database naming restrictions

Expand Down
11 changes: 5 additions & 6 deletions content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ InfluxData provides a Grafana operational dashboard that provides observability
into your {{< product-name >}} cluster.
Use the operational dashboard to monitor your cluster.

{{% note %}}
#### Not available for all clusters

{{< product-name >}} operational dashboards are not available for all clusters.
For questions about availability, [contact InfluxData support](https://support.influxdata.com).
{{% /note %}}
> [!Note]
> #### Not available for all clusters
>
> {{< product-name >}} operational dashboards are not available for all clusters.
> For questions about availability, [contact InfluxData support](https://support.influxdata.com).

- [Access your operational dashboard](#access-your-operational-dashboard)
- [Dashboard sections and cells](#dashboard-sections-and-cells)
Expand Down
69 changes: 32 additions & 37 deletions content/influxdb3/cloud-dedicated/admin/query-system-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,28 @@ You can query the cluster system tables for information about your cluster.
- [Storage usage](#storage-usage)
- [Compaction](#compaction)

{{% warn %}}
#### May impact cluster performance

Querying InfluxDB 3 system tables may impact write and query
performance of your {{< product-name omit=" Clustered" >}} cluster.
Use filters to [optimize queries to reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).

<!--------------- UPDATE THE DATE BELOW AS EXAMPLES ARE UPDATED --------------->

#### System tables are subject to change

System tables are not part of InfluxDB's stable API and may change with new releases.
The provided schema information and query examples are valid as of **September 18, 2024**.
If you detect a schema change or a non-functioning query example, please
[submit an issue](https://github.com/influxdata/docs-v2/issues/new/choose).

<!--------------- UPDATE THE DATE ABOVE AS EXAMPLES ARE UPDATED --------------->
{{% /warn %}}
> [!Warning]
> #### May impact cluster performance
>
> Querying InfluxDB 3 system tables may impact write and query
> performance of your {{< product-name omit=" Clustered" >}} cluster.
> Use filters to [optimize queries to reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).
>
> <!--------------- UPDATE THE DATE BELOW AS EXAMPLES ARE UPDATED --------------->
>
> #### System tables are subject to change
>
> System tables are not part of InfluxDB's stable API and may change with new releases.
> The provided schema information and query examples are valid as of **September 18, 2024**.
> If you detect a schema change or a non-functioning query example, please
> [submit an issue](https://github.com/influxdata/docs-v2/issues/new/choose).
>
> <!--------------- UPDATE THE DATE ABOVE AS EXAMPLES ARE UPDATED --------------->

## Query system tables

{{% note %}}
Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**.
{{% /note %}}
> [!Note]
> Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**.

Use the [`influxctl query` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/query/)
and SQL to query system tables.
Expand Down Expand Up @@ -258,9 +256,8 @@ Use the `AND`, `OR`, or `IN` keywords to combine filters in your query.

## System tables

{{% warn %}}
_System tables are [subject to change](#system-tables-are-subject-to-change)._
{{% /warn %}}
> [!Warning]
> _System tables are [subject to change](#system-tables-are-subject-to-change)._

### Understanding system table data distribution

Expand Down Expand Up @@ -323,11 +320,10 @@ The `system.queries` table contains the following columns:
{{% /expand %}}
{{< /expand-wrapper >}}

{{% note %}}
_When listing measurements (tables) available within a namespace,
some clients and query tools may include the `queries` table in the list of
namespace tables._
{{% /note %}}
> [!Note]
> _When listing measurements (tables) available within a namespace,
> some clients and query tools may include the `queries` table in the list of
> namespace tables._

### system.tables

Expand Down Expand Up @@ -390,14 +386,13 @@ The `system.compactor` table contains the following columns:

## System query examples

{{% warn %}}
#### May impact cluster performance

Querying InfluxDB 3 system tables may impact write and query
performance of your {{< product-name omit=" Clustered" >}} cluster.

The examples in this section include `WHERE` filters to [optimize queries and reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).
{{% /warn %}}
> [!Warning]
> #### May impact cluster performance
>
> Querying InfluxDB 3 system tables may impact write and query
> performance of your {{< product-name omit=" Clustered" >}} cluster.
>
> The examples in this section include `WHERE` filters to [optimize queries and reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).

- [Query logs](#query-logs)
- [View all stored query logs](#view-all-stored-query-logs)
Expand Down
28 changes: 13 additions & 15 deletions content/influxdb3/cloud-dedicated/admin/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,26 +101,24 @@ properly. For example:
new secret to InfluxData support for updating in the InfluxData-managed Auth0
service.

{{% note %}}
#### Keep client secrets secure

InfluxData provides a secure method for transmitting sensitive secrets such as
an OIDC client secret. Never send your client secret to InfluxData using an
insecure method.
{{% /note %}}
> [!Important]
> #### Keep client secrets secure
>
> InfluxData provides a secure method for transmitting sensitive secrets such as
> an OIDC client secret. Never send your client secret to InfluxData using an
> insecure method.

- **You're using SAML and your identity provider certificate is rotated**:
Provide the new certificate to InfluxData support for updating in the
InfluxData-managed Auth0 service.

{{% note %}}
#### SAML certificate rotation

Some identity providers that support SAML are known to rotate certificates often.
Each time the certificate is rotated, you must provide the updated certificate
to InfluxData support. Consider this when selecting an identity provider and
protocol to use.
{{% /note %}}
> [!Important]
> #### SAML certificate rotation
>
> Some identity providers that support SAML are known to rotate certificates often.
> Each time the certificate is rotated, you must provide the updated certificate
> to InfluxData support. Consider this when selecting an identity provider and
> protocol to use.

## Troubleshooting

Expand Down
7 changes: 3 additions & 4 deletions content/influxdb3/cloud-dedicated/admin/tables/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ influxdb3/cloud-dedicated/tags: [tables]
Manage tables in your {{< product-name omit=" Clustered" >}} cluster.
A table is a collection of related data stored in table format.

{{% note %}}
In previous versions of InfluxDB and in the context of InfluxQL, tables are
known as "measurements."
{{% /note %}}
> [!Note]
> In previous versions of InfluxDB and in the context of InfluxQL, tables are
> known as "measurements."

{{< children hlevel="h2" >}}
16 changes: 7 additions & 9 deletions content/influxdb3/cloud-dedicated/admin/tables/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,8 @@ to a table, you must manually create the table before you write any data to it.
- The name of the database to create the table in
- The name of the table to create

{{% note %}}
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
{{% /note %}}
> [!Note]
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._

{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
```sh
Expand Down Expand Up @@ -71,9 +70,8 @@ If no template flags are provided, the table uses the partition template of the
target database.
For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/).

{{% warn %}}
#### Partition templates can only be applied on create

You can only apply a partition template when creating a table.
There is no way to update a partition template on an existing table.
{{% /warn %}}
> [!Warning]
> #### Partition templates can only be applied on create
>
> You can only apply a partition template when creating a table.
> There is no way to update a partition template on an existing table.
9 changes: 2 additions & 7 deletions content/influxdb3/cloud-dedicated/admin/tables/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,8 @@ Use the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/
or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database)
to list tables in a database.

{{% note %}}
With {{< product-name >}}, tables and measurements are synonymous.
{{% /note %}}
> [!Note]
> With {{< product-name >}}, tables and measurements are synonymous.

###### SQL

Expand All @@ -50,10 +49,6 @@ SHOW MEASUREMENTS
To list tables using the `influxctl` CLI, use the `influxctl query` command to pass
the `SHOW TABLES` SQL statement.

{{% note %}}
The `influxctl query` command only supports SQL queries; not InfluxQL.
{{% /note %}}

Provide the following with your command:

- **Database token**: [Database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)
Expand Down
13 changes: 6 additions & 7 deletions content/influxdb3/cloud-dedicated/admin/tokens/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,12 @@ Management tokens allow clients, such as the
[`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/),
to perform administrative actions.

{{% note %}}
#### Store secure tokens in a secret store

Token strings are returned _only_ on token creation.
We recommend storing database tokens in a **secure secret store**.
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
{{% /note %}}
> [!Note]
> #### Store secure tokens in a secret store
>
> Token strings are returned _only_ on token creation.
> We recommend storing database tokens in a **secure secret store**.
> For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).

---

Expand Down
Loading