Skip to content

Commit e6fffd7

Browse files
authored
Merge branch 'master' into jstirnaman/issue5869
2 parents 3d4f78f + 271b0a2 commit e6fffd7

File tree

271 files changed

+3105
-3649
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

271 files changed

+3105
-3649
lines changed

content/influxdb3/cloud-dedicated/admin/databases/_index.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,16 @@ alt_links:
2424
An InfluxDB database is a named location where time series data is stored.
2525
Each InfluxDB database has a [retention period](#retention-periods).
2626

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

content/influxdb3/cloud-dedicated/admin/databases/create.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,8 @@ to create a database in your {{< product-name omit=" Clustered" >}} cluster.
101101
the time interval to partition by. Default is `%Y-%m-%d`.
102102
- Database name _(see [Database naming restrictions](#database-naming-restrictions))_
103103

104-
{{% note %}}
105-
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
106-
{{% /note %}}
104+
> [!Note]
105+
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
107106
108107
<!--Skip tests for database create and delete: namespaces aren't reusable-->
109108
<!--pytest.mark.skip-->
@@ -232,9 +231,8 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques
232231
the time interval to partition by. Default is `%Y-%m-%d`.
233232
- Database name _(see [Database naming restrictions](#database-naming-restrictions))_.
234233

235-
{{% note %}}
236-
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
237-
{{% /note %}}
234+
> [!Note]
235+
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
238236
239237
The following example shows how to use the Management API to create a database with custom partitioning:
240238

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

346-
{{% warn %}}
347-
348-
#### Partition templates can only be applied on create
349-
350-
You can only apply a partition template when creating a database.
351-
You can't update a partition template on an existing database.
352-
{{% /warn %}}
344+
> [!Warning]
345+
>
346+
> #### Partition templates can only be applied on create
347+
>
348+
> You can only apply a partition template when creating a database.
349+
> You can't update a partition template on an existing database.
353350
354351
### Database naming restrictions
355352

content/influxdb3/cloud-dedicated/admin/databases/delete.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,15 @@ related:
3131
Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)
3232
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster.
3333

34-
{{% warn %}}
35-
36-
#### Deleting a database cannot be undone
37-
38-
Once a database is deleted, data stored in that database cannot be recovered.
39-
40-
#### Cannot reuse database names
41-
42-
After a database is deleted, you cannot reuse the same name for a new database.
43-
{{% /warn %}}
34+
> [!Warning]
35+
>
36+
> #### Deleting a database cannot be undone
37+
>
38+
> Once a database is deleted, data stored in that database cannot be recovered.
39+
>
40+
> #### Cannot reuse database names
41+
>
42+
> After a database is deleted, you cannot reuse the same name for a new database.
4443
4544
{{< tabs-wrapper >}}
4645
{{% tabs %}}

content/influxdb3/cloud-dedicated/admin/databases/update.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,11 @@ Replace the following in your command:
7979

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

82-
{{% warn %}}
83-
#### Database names can't be updated
84-
85-
The `influxctl database update` command uses the database name to identify which
86-
database to apply updates to. The database name itself can't be updated.
87-
{{% /warn %}}
82+
> [!Warning]
83+
> #### Database names can't be updated
84+
>
85+
> The `influxctl database update` command uses the database name to identify which
86+
> database to apply updates to. The database name itself can't be updated.
8887
8988
## Database attributes
9089

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

220-
{{% warn %}}
221-
222-
#### Database names can't be updated
223-
224-
The Management API `PATCH /api/v0/database` endpoint and
225-
the`influxctl database update` command use the database name to identify which
226-
database to apply updates to.
227-
The database name itself can't be updated.
228-
229-
#### Partition templates can't be updated
230-
231-
You can only apply a partition template when creating a database.
232-
You can't update a partition template on an existing database.
233-
{{% /warn %}}
219+
> [!Warning]
220+
>
221+
> #### Database names can't be updated
222+
>
223+
> The Management API `PATCH /api/v0/database` endpoint and
224+
> the`influxctl database update` command use the database name to identify which
225+
> database to apply updates to.
226+
> The database name itself can't be updated.
227+
>
228+
> #### Partition templates can't be updated
229+
>
230+
> You can only apply a partition template when creating a database.
231+
> You can't update a partition template on an existing database.
234232
235233
### Database naming restrictions
236234

content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@ InfluxData provides a Grafana operational dashboard that provides observability
1414
into your {{< product-name >}} cluster.
1515
Use the operational dashboard to monitor your cluster.
1616

17-
{{% note %}}
18-
#### Not available for all clusters
19-
20-
{{< product-name >}} operational dashboards are not available for all clusters.
21-
For questions about availability, [contact InfluxData support](https://support.influxdata.com).
22-
{{% /note %}}
17+
> [!Note]
18+
> #### Not available for all clusters
19+
>
20+
> {{< product-name >}} operational dashboards are not available for all clusters.
21+
> For questions about availability, [contact InfluxData support](https://support.influxdata.com).
2322
2423
- [Access your operational dashboard](#access-your-operational-dashboard)
2524
- [Dashboard sections and cells](#dashboard-sections-and-cells)

content/influxdb3/cloud-dedicated/admin/query-system-data.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,28 @@ You can query the cluster system tables for information about your cluster.
3333
- [Storage usage](#storage-usage)
3434
- [Compaction](#compaction)
3535

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

57-
{{% note %}}
58-
Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**.
59-
{{% /note %}}
56+
> [!Note]
57+
> Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**.
6058
6159
Use the [`influxctl query` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/query/)
6260
and SQL to query system tables.
@@ -258,9 +256,8 @@ Use the `AND`, `OR`, or `IN` keywords to combine filters in your query.
258256

259257
## System tables
260258

261-
{{% warn %}}
262-
_System tables are [subject to change](#system-tables-are-subject-to-change)._
263-
{{% /warn %}}
259+
> [!Warning]
260+
> _System tables are [subject to change](#system-tables-are-subject-to-change)._
264261
265262
### Understanding system table data distribution
266263

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

326-
{{% note %}}
327-
_When listing measurements (tables) available within a namespace,
328-
some clients and query tools may include the `queries` table in the list of
329-
namespace tables._
330-
{{% /note %}}
323+
> [!Note]
324+
> _When listing measurements (tables) available within a namespace,
325+
> some clients and query tools may include the `queries` table in the list of
326+
> namespace tables._
331327
332328
### system.tables
333329

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

391387
## System query examples
392388

393-
{{% warn %}}
394-
#### May impact cluster performance
395-
396-
Querying InfluxDB 3 system tables may impact write and query
397-
performance of your {{< product-name omit=" Clustered" >}} cluster.
398-
399-
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).
400-
{{% /warn %}}
389+
> [!Warning]
390+
> #### May impact cluster performance
391+
>
392+
> Querying InfluxDB 3 system tables may impact write and query
393+
> performance of your {{< product-name omit=" Clustered" >}} cluster.
394+
>
395+
> 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).
401396
402397
- [Query logs](#query-logs)
403398
- [View all stored query logs](#view-all-stored-query-logs)

content/influxdb3/cloud-dedicated/admin/sso.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,26 +101,24 @@ properly. For example:
101101
new secret to InfluxData support for updating in the InfluxData-managed Auth0
102102
service.
103103
104-
{{% note %}}
105-
#### Keep client secrets secure
106-
107-
InfluxData provides a secure method for transmitting sensitive secrets such as
108-
an OIDC client secret. Never send your client secret to InfluxData using an
109-
insecure method.
110-
{{% /note %}}
104+
> [!Important]
105+
> #### Keep client secrets secure
106+
>
107+
> InfluxData provides a secure method for transmitting sensitive secrets such as
108+
> an OIDC client secret. Never send your client secret to InfluxData using an
109+
> insecure method.
111110
112111
- **You're using SAML and your identity provider certificate is rotated**:
113112
Provide the new certificate to InfluxData support for updating in the
114113
InfluxData-managed Auth0 service.
115114
116-
{{% note %}}
117-
#### SAML certificate rotation
118-
119-
Some identity providers that support SAML are known to rotate certificates often.
120-
Each time the certificate is rotated, you must provide the updated certificate
121-
to InfluxData support. Consider this when selecting an identity provider and
122-
protocol to use.
123-
{{% /note %}}
115+
> [!Important]
116+
> #### SAML certificate rotation
117+
>
118+
> Some identity providers that support SAML are known to rotate certificates often.
119+
> Each time the certificate is rotated, you must provide the updated certificate
120+
> to InfluxData support. Consider this when selecting an identity provider and
121+
> protocol to use.
124122
125123
## Troubleshooting
126124

content/influxdb3/cloud-dedicated/admin/tables/_index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ influxdb3/cloud-dedicated/tags: [tables]
1515
Manage tables in your {{< product-name omit=" Clustered" >}} cluster.
1616
A table is a collection of related data stored in table format.
1717

18-
{{% note %}}
19-
In previous versions of InfluxDB and in the context of InfluxQL, tables are
20-
known as "measurements."
21-
{{% /note %}}
18+
> [!Note]
19+
> In previous versions of InfluxDB and in the context of InfluxQL, tables are
20+
> known as "measurements."
2221
2322
{{< children hlevel="h2" >}}

content/influxdb3/cloud-dedicated/admin/tables/create.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,8 @@ to a table, you must manually create the table before you write any data to it.
4040
- The name of the database to create the table in
4141
- The name of the table to create
4242

43-
{{% note %}}
44-
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
45-
{{% /note %}}
43+
> [!Note]
44+
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
4645
4746
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
4847
```sh
@@ -71,9 +70,8 @@ If no template flags are provided, the table uses the partition template of the
7170
target database.
7271
For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/).
7372

74-
{{% warn %}}
75-
#### Partition templates can only be applied on create
76-
77-
You can only apply a partition template when creating a table.
78-
There is no way to update a partition template on an existing table.
79-
{{% /warn %}}
73+
> [!Warning]
74+
> #### Partition templates can only be applied on create
75+
>
76+
> You can only apply a partition template when creating a table.
77+
> There is no way to update a partition template on an existing table.

content/influxdb3/cloud-dedicated/admin/tables/list.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@ Use the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/
2929
or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database)
3030
to list tables in a database.
3131

32-
{{% note %}}
33-
With {{< product-name >}}, tables and measurements are synonymous.
34-
{{% /note %}}
32+
> [!Note]
33+
> With {{< product-name >}}, tables and measurements are synonymous.
3534
3635
###### SQL
3736

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

53-
{{% note %}}
54-
The `influxctl query` command only supports SQL queries; not InfluxQL.
55-
{{% /note %}}
56-
5752
Provide the following with your command:
5853

5954
- **Database token**: [Database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)

0 commit comments

Comments
 (0)