You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cloud/manage/jan2025_faq/plan_migrations.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,19 +28,21 @@ Yes, see below for guidance on self-serve migrations:
28
28
29
29
Users can upgrade during the trial and continue to use the trial credits to evaluate the new service tiers and the features it supports. However, if they choose to continue using the same Development and Production services, they can do so and upgrade to PAYG. They will still have to migrate before July 23, 2025.
30
30
31
-
### Can users upgrade their tiers, i.e. Basic → Scale, Scale → Enterprise, etc? {#can-users-upgrade-their-tiers-ie-basic--scale-scale--enterprise-etc}
31
+
### Can users upgrade their tiers {#can-users-upgrade-their-tiers-ie-basic--scale-scale--enterprise-etc}
32
32
33
-
Yes, users can upgrade self-serve and the pricing will reflect the tier selection after upgrade.
33
+
Can users upgrade their tiers, for example, Basic → Scale, Scale → Enterprise, etc.
34
+
Yes, users can upgrade self-serve, and the pricing will reflect the tier selection after upgrade.
34
35
35
-
### Can users move from a higher to a lower-cost tier, e.g., Enterprise → Scale, Scale → Basic, Enterprise → Basic self-serve? {#can-users-move-from-a-higher-to-a-lower-cost-tier-eg-enterprise--scale-scale--basic-enterprise--basic-self-serve}
36
+
### Can users move from a higher to a lower-cost tier {#can-users-move-from-a-higher-to-a-lower-cost-tier-eg-enterprise--scale-scale--basic-enterprise--basic-self-serve}
36
37
38
+
For example, Enterprise → Scale, Scale → Basic, Enterprise → Basic self-serve?
37
39
No, we do not permit downgrading tiers.
38
40
39
-
### Can users with only Development services in the organization migrate to the Basic tier? {#can-users-with-only-development-services-in-the-organization-migrate-to-the-basic-tier}
41
+
### Can users with only development services in the organization migrate to the Basic tier? {#can-users-with-only-development-services-in-the-organization-migrate-to-the-basic-tier}
40
42
41
43
Yes, this would be permitted. Users will be given a recommendation based on their past use and can select Basic `1x8GiB` or `1x12GiB`.
42
44
43
-
### Can users with a Development and Production service in the same organization move to the Basic Tier? {#can-users-with-a-development-and-production-service-in-the-same-organization-move-to-the-basic-tier}
45
+
### Can users with a development and production service in the same organization move to the basic tier? {#can-users-with-a-development-and-production-service-in-the-same-organization-move-to-the-basic-tier}
44
46
45
47
No, if a user has both Development and Production services in the same organization, they can self-serve and migrate only to the Scale or Enterprise tier. If they want to migrate to Basic, they should delete all existing Production services.
*[Variables](https://learning.postman.com/docs/sending-requests/variables/) enable the storage and reuse of values in Postman allowing for easier API testing.
77
-
#### Set the Organization ID and Service ID {#set-the-organization-id-and-service-id}
81
+
82
+
#### Set the organization ID and Service ID {#set-the-organization-id-and-service-id}
83
+
78
84
* Within the "Collection", click the "Variable" tab in the middle pane (The Base URL will have been set by the earlier API import):
79
85
* Below `baseURL` click the open field "Add new value", and Substitute your organization ID and service ID:
80
86
81
87
<Imageimg={postman11}size="md"alt="Organization ID and Service ID"border/>
82
88
83
89
84
90
## Test the ClickHouse Cloud API functionalities {#test-the-clickhouse-cloud-api-functionalities}
91
+
85
92
### Test "GET list of available organizations" {#test-get-list-of-available-organizations}
93
+
86
94
* Under the "OpenAPI spec for ClickHouse Cloud", expand the folder > V1 > organizations
87
95
* Click "GET list of available organizations" and press the blue "Send" button on the right:
88
96
@@ -93,6 +101,7 @@ The Postman Application is available for use within a web browser or can be down
### Test "GET organizational details" {#test-get-organizational-details}
104
+
96
105
* Under the `organizationid` folder, navigate to "GET organizational details":
97
106
* In the middle frame menu under Params an `organizationid` is required.
98
107
@@ -109,6 +118,7 @@ The Postman Application is available for use within a web browser or can be down
109
118
* The returned results should deliver your organization details with "status": 200. (If you receive a "status" 400 with no organization information your configuration is not correct).
110
119
111
120
### Test "GET service details" {#test-get-service-details}
121
+
112
122
* Click "GET service details"
113
123
* Edit the Values for `organizationid` and `serviceid` with `{{orgid}}` and `{{serviceid}}` respectively.
114
124
* Press "Save" and then the blue "Send" button on the right.
Copy file name to clipboardExpand all lines: docs/cloud/manage/scaling.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ import scaling_configure from '@site/static/images/cloud/manage/scaling-configur
15
15
import scaling_memory_allocation from '@site/static/images/cloud/manage/scaling-memory-allocation.png';
16
16
import ScalePlanFeatureBadge from '@theme/badges/ScalePlanFeatureBadge'
17
17
18
-
# Automatic Scaling
18
+
# Automatic scaling
19
19
20
20
Scaling is the ability to adjust available resources to meet client demands. Scale and Enterprise (with standard 1:4 profile) tier services can be scaled horizontally by calling an API programmatically, or changing settings on the UI to adjust system resources. Alternatively, these services can be **autoscaled** vertically to meet application demands.
21
21
@@ -110,7 +110,7 @@ Once the service has scaled, the metrics dashboard in the cloud console should s
In the **Settings** page, you can also choose whether or not to allow automatic idling of your service when it is inactive as shown in the image above (i.e. when the service is not executing any user-submitted queries). Automatic idling reduces the cost of your service, as you are not billed for compute resources when the service is paused.
115
115
116
116
:::note
@@ -123,7 +123,8 @@ The service may enter an idle state where it suspends refreshes of [refreshable
123
123
Use automatic idling only if your use case can handle a delay before responding to queries, because when a service is paused, connections to the service will time out. Automatic idling is ideal for services that are used infrequently and where a delay can be tolerated. It is not recommended for services that power customer-facing features that are used frequently.
Copy file name to clipboardExpand all lines: docs/cloud/manage/settings.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ description: 'How to configure settings for your ClickHouse Cloud service for a
8
8
import Image from '@theme/IdealImage';
9
9
import cloud_settings_sidebar from '@site/static/images/cloud/manage/cloud-settings-sidebar.png';
10
10
11
-
# Configuring Settings
11
+
# Configuring settings
12
12
13
13
To specify settings for your ClickHouse Cloud service for a specific [user](/operations/access-rights#user-account-management) or [role](/operations/access-rights#role-management), you must use [SQL-driven Settings Profiles](/operations/access-rights#settings-profiles-management). Applying Settings Profiles ensures that the settings you configure persist, even when your services stop, idle, and upgrade. To learn more about Settings Profiles, please see [this page](/operations/settings/settings-profiles.md).
Copy file name to clipboardExpand all lines: docs/cloud/reference/byoc.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,23 +48,23 @@ Metrics and logs are stored within the customer's BYOC VPC. Logs are currently s
48
48
49
49
<br />
50
50
51
-
## Onboarding Process {#onboarding-process}
51
+
## Onboarding process {#onboarding-process}
52
52
53
53
Customers can initiate the onboarding process by reaching out to [us](https://clickhouse.com/cloud/bring-your-own-cloud). Customers need to have a dedicated AWS account and know the region they will use. At this time, we are allowing users to launch BYOC services only in the regions that we support for ClickHouse Cloud.
54
54
55
-
### Prepare an AWS Account {#prepare-an-aws-account}
55
+
### Prepare an AWS account {#prepare-an-aws-account}
56
56
57
57
Customers are recommended to prepare a dedicated AWS account for hosting the ClickHouse BYOC deployment to ensure better isolation. However, using a shared account and an existing VPC is also possible. See the details in *Setup BYOC Infrastructure* below.
58
58
59
59
With this account and the initial organization admin email, you can contact ClickHouse support.
BYOC setup is initialized via a [CloudFormation stack](https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/cf-templates/byoc.yaml), which creates only a role allowing BYOC controllers from ClickHouse Cloud to manage infrastructure. The S3, VPC, and compute resources for running ClickHouse are not included in this stack.
64
64
65
65
<!-- TODO: Add Screenshot for the rest of onboarding, once self-served onboarding is implemented. -->
### Set up BYOC infrastructure {#setup-byoc-infrastructure}
68
68
69
69
After creating the CloudFormation stack, you will be prompted to set up the infrastructure, including S3, VPC, and the EKS cluster, from the cloud console. Certain configurations must be determined at this stage, as they cannot be changed later. Specifically:
70
70
@@ -106,7 +106,7 @@ Create a support ticket with the following information:
106
106
107
107
To create or delete VPC peering for ClickHouse BYOC, follow the steps:
Contact ClickHouse Support to enable Private Load Balancer.
111
111
112
112
#### Step 2 Create a peering connection {#step-2-create-a-peering-connection}
@@ -162,7 +162,7 @@ In the peering AWS account,
162
162
163
163
<br />
164
164
165
-
#### Step 6 Edit Security Group to allow Peered VPC access {#step-6-edit-security-group-to-allow-peered-vpc-access}
165
+
#### Step 6: Edit security group to allow peered VPC access {#step-6-edit-security-group-to-allow-peered-vpc-access}
166
166
In the ClickHouse BYOC account, you need to update the Security Group settings to allow traffic from your peered VPC. Please contact ClickHouse Support to request the addition of inbound rules that include the CIDR ranges of your peered VPC.
167
167
168
168
---
@@ -174,7 +174,7 @@ To access ClickHouse privately, a private load balancer and endpoint are provisi
174
174
175
175
Optional, after verifying that peering is working, you can request the removal of the public load balancer for ClickHouse BYOC.
176
176
177
-
## Upgrade Process {#upgrade-process}
177
+
## Upgrade process {#upgrade-process}
178
178
179
179
We regularly upgrade the software, including ClickHouse database version upgrades, ClickHouse Operator, EKS, and other components.
180
180
@@ -184,7 +184,7 @@ While we aim for seamless upgrades (e.g., rolling upgrades and restarts), some,
184
184
Maintenance windows do not apply to security and vulnerability fixes. These are handled as off-cycle upgrades, with timely communication to coordinate a suitable time and minimize operational impact.
185
185
:::
186
186
187
-
## CloudFormation IAM Roles {#cloudformation-iam-roles}
187
+
## CloudFormation IAM roles {#cloudformation-iam-roles}
188
188
189
189
### Bootstrap IAM role {#bootstrap-iam-role}
190
190
@@ -218,7 +218,7 @@ These roles are assumed by applications running within the customer's EKS cluste
218
218
219
219
Lastly, **`data-plane-mgmt`** allows a ClickHouse Cloud Control Plane component to reconcile necessary custom resources, such as `ClickHouseCluster` and the Istio Virtual Service/Gateway.
220
220
221
-
## Network Boundaries {#network-boundaries}
221
+
## Network boundaries {#network-boundaries}
222
222
223
223
This section covers different network traffic to and from the customer BYOC VPC:
224
224
@@ -309,7 +309,7 @@ Besides Clickhouse instances (ClickHouse servers and ClickHouse Keeper), we run
309
309
310
310
Currently we have 3 m5.xlarge nodes (one for each AZ) in a dedicated node group to run those workloads.
311
311
312
-
### Network and Security {#network-and-security}
312
+
### Network and security {#network-and-security}
313
313
314
314
#### Can we revoke permissions set up during installation after setup is complete? {#can-we-revoke-permissions-set-up-during-installation-after-setup-is-complete}
315
315
@@ -331,9 +331,9 @@ Contact support to schedule maintenance windows. Please expect a minimum of a we
ClickHouse Cloud includes an advanced observability dashboard that displays metrics such as memory usage, query rates, and I/O. This can be accessed in the **Monitoring** section of ClickHouse Cloud web console interface.
339
339
@@ -343,7 +343,7 @@ ClickHouse Cloud includes an advanced observability dashboard that displays metr
343
343
344
344
<br />
345
345
346
-
#### Advanced Dashboard {#advanced-dashboard}
346
+
#### Advanced dashboard {#advanced-dashboard}
347
347
348
348
You can customize a dashboard using metrics from system tables like `system.metrics`, `system.events`, and `system.asynchronous_metrics` and more to monitor server performance and resource utilization in detail.
Copy file name to clipboardExpand all lines: docs/cloud/reference/changelog.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -274,7 +274,7 @@ Org Admins can now add more email addresses to a specific notification as additi
274
274
275
275
Bring Your Own Cloud for AWS is now available in Beta. This deployment model allows you to deploy and run ClickHouse Cloud in your own AWS account. We support deployments in 11+ AWS regions, with more coming soon. Please [contact support](https://clickhouse.com/support/program) for access. Note that this deployment is reserved for large-scale deployments.
276
276
277
-
### Postgres Change Data Capture (CDC) Connector in ClickPipes {#postgres-change-data-capture-cdc-connector-in-clickpipes}
277
+
### Postgres Change Data Capture (CDC) connector in ClickPipes {#postgres-change-data-capture-cdc-connector-in-clickpipes}
278
278
279
279
This turnkey integration enables customers to replicate their Postgres databases to ClickHouse Cloud in just a few clicks and leverage ClickHouse for blazing-fast analytics. You can use this connector for both continuous replication and one-time migrations from Postgres.
280
280
@@ -553,7 +553,7 @@ You can try the new Amazon Kinesis integration for ClickPipes in the cloud conso
Backups are important for every database (no matter how reliable), and we've taken backups very seriously since day 1 of ClickHouse Cloud. This week, we launched Configurable Backups, which allows for much more flexibility for your service's backups. You can now control start time, retention, and frequency. This feature is available for **Production** and **Dedicated** services and is not available for **Development** services. As this feature is in private preview, please contact [email protected] to enable this for your service. Read more about configurable backups [here](https://clickhouse.com/blog/configurable-backups-in-clickhouse-cloud).
559
559
@@ -1020,14 +1020,15 @@ This release brings the public release of the ClickHouse Cloud Programmatic API
1020
1020
1021
1021
## May 11, 2023 {#may-11-2023}
1022
1022
1023
-
This release brings the ~~public beta~~ (now GA, see June 20th entry above) of ClickHouse Cloud on GCP (see [blog](https://clickhouse.com/blog/clickhouse-cloud-on-gcp-available-in-public-beta) for details), extends administrators rights to grant terminate query permissions, and adds more visibility into the status of MFA users in the Cloud console.
1023
+
This release brings the public beta (now GA, see June 20th entry above) of ClickHouse Cloud on GCP (see [blog](https://clickhouse.com/blog/clickhouse-cloud-on-gcp-available-in-public-beta) for details), extends administrators' rights to grant terminate query permissions, and adds more visibility into the status of MFA users in the Cloud console.
1024
1024
1025
-
### ClickHouse Cloud on GCP ~~(Public Beta)~~(now GA, see June 20th entry above) {#clickhouse-cloud-on-gcp-public-beta-now-ga-see-june-20th-entry-above}
1025
+
### ClickHouse Cloud on GCP is now available in public beta (now GA, see June 20th entry above) {#clickhouse-cloud-on-gcp-is-now-available-in-public-beta-now-ga-see-june-20th-entry-above}
1026
1026
- Launches a fully-managed separated storage and compute ClickHouse offering, running on top of Google Compute and Google Cloud Storage
1027
1027
- Available in Iowa (us-central1), Netherlands (europe-west4), and Singapore (asia-southeast1) regions
1028
1028
- Supports both Development and Production services in all three initial regions
1029
1029
- Provides strong security by default: End-to-end encryption in transit, data-at-rest encryption, IP Allow Lists
- The [Metabase plugin](/integrations/data-visualization/metabase-and-clickhouse.md) got a long-awaited v0.9.1 major update. Now it is compatible with the latest Metabase version and has been thoroughly tested against ClickHouse Cloud.
1281
1282
1282
-
## December 6, 2022 - General Availability {#december-6-2022---general-availability}
1283
+
## December 6, 2022 - General availability {#december-6-2022---general-availability}
1283
1284
1284
1285
ClickHouse Cloud is now production-ready with SOC2 Type II compliance, uptime SLAs for production workloads, and public status page. This release includes major new capabilities like AWS Marketplace integration, SQL console - a data exploration workbench for ClickHouse users, and ClickHouse Academy - self-paced learning in ClickHouse Cloud. Learn more in this [blog](https://clickhouse.com/blog/clickhouse-cloud-generally-available).
0 commit comments