Skip to content
Merged
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
Binary file removed docs/_assets/img/cluster-table-policy-create.png
Binary file not shown.
Binary file added docs/_assets/img/cluster-table-policy-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 10 additions & 13 deletions docs/cluster/automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and optimization of database tasks.
:::{important}
- Automation is available for all newly deployed clusters.
- For existing clusters, the feature can be enabled on demand. (Contact
[support](https://support.crate.io/) for activation.)
[support](https://support.cratedb.com/) for activation.)

Automation utilizes a dedicated database user `gc_admin` with full cluster
privileges to execute scheduled tasks and persists data in the `gc` schema.
Expand Down Expand Up @@ -124,23 +124,20 @@ ruleset.

### Overview

Table policy overview can be found in the left-hand navigation menu under
The table policy overview can be found in the left-hand navigation menu under
"Automation". From the list of policies, you can create, delete, edit, or
(de)activate them. Logs of executed policies can be found in the "Logs" tab.

![Table policy list](../_assets/img/cluster-table-policy-logs.png)

A new policy can be created with the "Add New Policy" button.

![Table policy list](../_assets/img/cluster-table-policy-create.png)
![Table policy list](../_assets/img/cluster-table-policy-edit.png)

After naming the policy and selecting the tables/schemas to be impacted, you
After naming the policy and selecting the table to be impacted, you
must specify the time column. This column, which should be a timestamp used for
partitioning, will determine the data affected by the policy. It is important
that this time column is consistently present across all targeted tables/schemas.
While you can apply the policy to tables without the specified time column,
it will not get executed for those. If your tables have different timestamp
columns, consider setting up separate policies for each to ensure accuracy.
partitioning, will determine the data affected by the policy. If you have multiple
partitioned tables you will need to setup a policy per table.

:::{note}
The "Time Column" must be of type `TIMESTAMP`.
Expand All @@ -149,7 +146,7 @@ The "Time Column" must be of type `TIMESTAMP`.
Next, a condition is used to determine affected partitions. The system is
time-based. A partition is eligible for action if the value in the partitioned
column is smaller (`<`), or smaller or equal (`<=`) than the current date minus
`n` days, months, or years.
`n` hours, days, weeks, months, or years.

### Actions

Expand All @@ -158,14 +155,14 @@ Following actions are supported:
* **Set replicas:** Changes the replication factor of eligible partitions.
* **Force merge:** Merges segments on eligible partitions to ensure a specified number.

After filling out the info, you can see the affected schemas/tables and the
number of affected partitions if the policy gets executed at this very moment.
After filling out the info, you can see the number of partitions that will be affected
if the policy gets executed now.

### Examples

Consider a scenario where you have a table and want to optimize space on your
cluster. For older data (e.g., 30 days), which may have already been snapshotted
and is only accessed infrequently, meaning it's not used for live analyitcs, it
and is only accessed infrequently, meaning it's not used for live analytics, it
might be sufficient for it to exist just once in the cluster without replication.
Additionally, you may not want to retain data older than 60 days.

Expand Down
2 changes: 1 addition & 1 deletion docs/cluster/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ against their CrateDB cluster. The Console can be accessed by users having the
:::{important}
- The Console is available for all newly deployed clusters.
- For older clusters, this feature can be enabled on demand. Contact
[support](https://support.crate.io/) for activation.
[support](https://support.cratedb.com/) for activation.

The Console currently utilizes a dedicated database user `gc_admin` with full
cluster privileges.
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
# unauthorized
"https://portal.aws.amazon.com/",
"https://console.cratedb.cloud/api/docs",
# 403 for non-browser clients (bot protection)
"https://www.ibm.com/docs/",
]

linkcheck_timeout = 5
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Learn about all compatible client applications, frameworks, and tools.
[Auditing]: https://cratedb.com/product/features/auditing
[AWS Marketplace]: https://aws.amazon.com/marketplace/pp/prodview-l7rqf2xpeaubk
[Azure Marketplace]: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/crate.cratedbcloud?tab=overview
[CCPA]: https://leginfo.legislature.ca.gov/faces/codes_displaySection.xhtml?lawCode=CIV&sectionNum=1798.140.
[CCPA]: https://oag.ca.gov/privacy/ccpa
[Database Features]: https://cratedb.com/docs/guide/feature/
[Encryption]: https://cratedb.com/product/features/data-encryption
[GCP Marketplace]: https://console.cloud.google.com/marketplace/product/cratedb-public/cratedb-gcp
Expand Down
Loading