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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 0 additions & 10 deletions docs/_placeholders/api/_invitations-api-reference.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_placeholders/api/_keys-api-reference.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_placeholders/api/_members-api-reference.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_placeholders/api/_organizations-api-reference.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_placeholders/api/_services-api-reference.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_placeholders/changelog/_index.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/about-us/about-faq-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'FAQ'
slug: /about-us/faq
description: 'Landing page'
doc_type: 'landing-page'
keywords: ['ClickHouse FAQ', 'frequently asked questions', 'common questions', 'help documentation', 'troubleshooting']
---

| FAQ |
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/adopters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Adopters'
title: 'ClickHouse Adopters'
sidebar_position: 60
description: 'A list of companies using ClickHouse and their success stories'
keywords: ['ClickHouse adopters', 'success stories', 'case studies', 'company testimonials', 'ClickHouse users']
doc_type: 'reference'
---

Expand Down
1 change: 1 addition & 0 deletions docs/about-us/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Cloud service'
sidebar_position: 10
description: 'ClickHouse Cloud'
title: 'ClickHouse Cloud'
keywords: ['ClickHouse Cloud', 'cloud database', 'managed ClickHouse', 'serverless database', 'cloud OLAP']
doc_type: 'reference'
---

Expand Down
1 change: 1 addition & 0 deletions docs/about-us/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /about
title: 'About ClickHouse'
description: 'Landing page for About ClickHouse'
doc_type: 'landing-page'
keywords: ['about', 'overview', 'introduction']
---

# About ClickHouse
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: 'ClickHouse Cloud support services'
sidebar_position: 30
description: 'Information on ClickHouse Cloud support services'
doc_type: 'reference'
keywords: ['support', 'help', 'customer service', 'technical support', 'service level agreement']
---

# ClickHouse Cloud support services
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_position: 4
title: 'Sizing and hardware recommendations'
description: 'This guide discusses our general recommendations regarding hardware, compute, memory, and disk configurations for open-source users.'
doc_type: 'guide'
keywords: ['sizing', 'hardware', 'capacity planning', 'best practices', 'performance']
---

# Sizing and hardware recommendations
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/01_cloud_tiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'ClickHouse Cloud tiers'
slug: /cloud/manage/cloud-tiers
title: 'ClickHouse Cloud Tiers'
description: 'Cloud tiers available in ClickHouse Cloud'
keywords: ['cloud tiers', 'service plans', 'cloud pricing tiers', 'cloud service levels']
doc_type: 'reference'
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/02_integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /manage/integrations
title: 'Integrations'
description: 'Integrations for ClickHouse'
doc_type: 'landing-page'
keywords: ['integrations', 'cloud features', 'third-party tools', 'data sources', 'connectors']
---

import Kafkasvg from '@site/static/images/integrations/logos/kafka.svg';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/manage/dashboards
title: 'Dashboards'
description: 'The SQL Console''s dashboards feature allows you to collect and share visualizations from saved queries.'
doc_type: 'guide'
keywords: ['ClickHouse Cloud', 'dashboards', 'data visualization', 'SQL console dashboards', 'cloud analytics']
---

import BetaBadge from '@theme/badges/BetaBadge';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/03_sql_console_features/hyperdx.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/manage/hyperdx
title: 'HyperDX'
description: 'Provides HyperDX, the UI for ClickStack - a production-grade observability platform built on ClickHouse and OpenTelemetry (OTel), unifying logs, traces, metrics, and sessions in a single high-performance scalable solution.'
doc_type: 'guide'
keywords: ['hyperdx', 'observability', 'integration', 'cloud features', 'monitoring']
---

import PrivatePreviewBadge from '@theme/badges/PrivatePreviewBadge';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: 'ClickHouse Cloud API'
slug: /cloud/manage/api/api-overview
description: 'Learn about ClickHouse Cloud API'
doc_type: 'reference'
keywords: ['ClickHouse Cloud', 'API overview', 'cloud API', 'REST API', 'programmatic access']
---

# ClickHouse Cloud API
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/05_admin_features/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'Cloud API'
slug: /cloud/manage/cloud-api
description: 'Landing page for the Cloud API section'
doc_type: 'landing-page'
keywords: ['ClickHouse Cloud', 'cloud API', 'API documentation', 'REST API reference', 'cloud management API']
---

This section contains reference documentation for Cloud API and contains the following pages:
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/05_admin_features/api/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/manage/openapi
title: 'Managing API Keys'
description: 'ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.'
doc_type: 'guide'
keywords: ['api', 'openapi', 'rest api', 'documentation', 'cloud management']
---

import image_01 from '@site/static/images/cloud/manage/openapi1.png';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/05_admin_features/api/postman.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Programmatic API access with Postman'
title: 'Programmatic API access with Postman'
description: 'This guide will help you test the ClickHouse Cloud API using Postman'
doc_type: 'guide'
keywords: ['api', 'postman', 'rest api', 'cloud management', 'integration']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/05_admin_features/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /manage/updates
title: 'Upgrades'
description: 'With ClickHouse Cloud you never have to worry about patching and upgrades. We roll out upgrades that include fixes, new features and performance improvements on a periodic basis.'
doc_type: 'guide'
keywords: ['upgrades', 'version management', 'cloud features', 'maintenance', 'updates']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/06_security.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security
title: 'Security'
description: 'Learn more about securing ClickHouse Cloud and BYOC'
doc_type: 'reference'
keywords: ['security', 'cloud security', 'access control', 'compliance', 'data protection']
---

# ClickHouse Cloud Security
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: 'Take a backup or restore a backup from the UI'
description: 'Page describing how to take a backup or restore a backup from the UI with your own bucket'
sidebar_position: 2
doc_type: 'guide'
keywords: ['backups', 'disaster recovery', 'data protection', 'restore', 'cloud features']
---

import Image from '@theme/IdealImage'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: 'Take a backup or restore a backup using commands'
description: 'Page describing how to take a backup or restore a backup with your own bucket using commands'
sidebar_position: 3
doc_type: 'guide'
keywords: ['backups', 'disaster recovery', 'data protection', 'restore', 'cloud features']
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: 'Export Backups to your Own Cloud Account'
description: 'Describes how to export backups to your own Cloud account'
sidebar_position: 1
doc_type: 'guide'
keywords: ['backups', 'disaster recovery', 'data protection', 'restore', 'cloud features']
---

import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge'
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/features/09_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Cloud support'
title: 'Support'
slug: /cloud/support
description: 'Learn about Cloud Support'
keywords: ['ClickHouse Cloud', 'cloud support', 'customer support', 'technical assistance', 'managed service support']
hide_title: true
doc_type: 'guide'
---
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/SQL_console/connection_details.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Gather your connection details'
title: 'Gather your connection details'
description: 'Gather your connection details'
doc_type: 'guide'
keywords: ['connection details', 'credentials', 'connection string', 'setup', 'configuration']
---

import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/best_practices/multitenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Multi tenancy'
title: 'Multi tenancy'
description: 'Best practices to implement multi tenancy'
doc_type: 'guide'
keywords: ['multitenancy', 'isolation', 'best practices', 'architecture', 'multi-tenant']
---

On a SaaS data analytics platform, it is common for multiple tenants, such as organizations, customers, or business units, to share the same database infrastructure while maintaining logical separation of their data. This allows different users to securely access their own data within the same platform.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/best_practices/usagelimits.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Service limits'
title: 'Usage limits'
description: 'Describes the recommended usage limits in ClickHouse Cloud'
doc_type: 'reference'
keywords: ['usage limits', 'quotas', 'best practices', 'resource management', 'cloud features']
---

While ClickHouse is known for its speed and reliability, optimal performance is
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/cloud-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /whats-new/cloud-compatibility
sidebar_label: 'Cloud compatibility'
title: 'Cloud Compatibility'
description: 'This guide provides an overview of what to expect functionally and operationally in ClickHouse Cloud.'
keywords: ['ClickHouse Cloud', 'compatibility']
doc_type: 'guide'
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/data_sources/01_cloud-endpoints-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Cloud IP addresses'
title: 'Cloud IP addresses'
description: 'This page documents the Cloud Endpoints API security features within ClickHouse. It details how to secure your ClickHouse deployments by managing access through authentication and authorization mechanisms.'
doc_type: 'reference'
keywords: ['ClickHouse Cloud', 'static IP addresses', 'cloud endpoints', 'API', 'security', 'egress IPs', 'ingress IPs', 'firewall']
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/data-sources/secure-s3
sidebar_label: 'Accessing S3 data securely'
title: 'Accessing S3 data securely'
description: 'This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access their data securely.'
keywords: ['RBAC', 'Amazon S3', 'authentication']
doc_type: 'guide'
---

Expand All @@ -11,7 +12,7 @@ import secure_s3 from '@site/static/images/cloud/security/secures3.jpg';
import s3_info from '@site/static/images/cloud/security/secures3_arn.png';
import s3_output from '@site/static/images/cloud/security/secures3_output.jpg';

This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access their data securely.
This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service (S3) and access their data securely.

## Introduction {#introduction}

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/data_sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'Data sources'
hide_title: true
description: 'Table of contents page for the ClickHouse Cloud guides section'
doc_type: 'landing-page'
keywords: ['cloud guides', 'documentation', 'how-to', 'cloud features', 'tutorials']
---

## Cloud integrations {#cloud-integrations}
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'Guides'
hide_title: true
description: 'Table of contents page for the ClickHouse Cloud guides section'
doc_type: 'landing-page'
keywords: ['cloud guides', 'documentation', 'how-to', 'cloud features', 'tutorials']
---

<!--AUTOGENERATED_START-->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security/manage-my-account
title: 'Manage my account'
description: 'This page describes how users can accept invitations, manage MFA settings, and reset passwords'
doc_type: 'guide'
keywords: ['account management', 'user profile', 'security', 'cloud console', 'settings']
---

import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security/manage-cloud-users
title: 'Manage cloud users'
description: 'This page describes how administrators can add users, manage assignments, and remove users'
doc_type: 'guide'
keywords: ['cloud users', 'access management', 'security', 'permissions', 'team management']
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Manage SQL console role assignments'
title: 'Manage SQL console role assignments'
description: 'Guide showing how to manage SQL console role assignments'
doc_type: 'guide'
keywords: ['sql console', 'role assignments', 'access management', 'permissions', 'security']
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security/manage-database-users
title: 'Manage database users'
description: 'This page describes how administrators can add database users, manage assignments, and remove database users'
doc_type: 'guide'
keywords: ['database users', 'access management', 'security', 'permissions', 'user management']
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security/saml-setup
title: 'SAML SSO setup'
description: 'How to set up SAML SSO with ClickHouse Cloud'
doc_type: 'guide'
keywords: ['ClickHouse Cloud', 'SAML', 'SSO', 'single sign-on', 'IdP', 'Okta', 'Google']
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Common access management queries'
title: 'Common access management queries'
slug: /cloud/security/common-access-management-queries
description: 'This article shows the basics of defining SQL users and roles and applying those privileges and permissions to databases, tables, rows, and columns.'
keywords: ['ClickHouse Cloud', 'access management']
doc_type: 'guide'
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security/cloud_access_management
title: 'Cloud access management'
description: 'Learn more about cloud access management'
doc_type: 'landing-page'
keywords: ['access management', 'security', 'user management', 'permissions', 'authentication']
---

# Cloud access management
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security/setting-ip-filters
title: 'Setting IP filters'
description: 'This page explains how to set IP filters in ClickHouse Cloud to control access to ClickHouse services.'
doc_type: 'guide'
keywords: ['IP filters', 'IP access list']
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'AWS PrivateLink'
description: 'This document describes how to connect to ClickHouse Cloud using AWS PrivateLink.'
slug: /manage/security/aws-privatelink
keywords: ['PrivateLink']
doc_type: 'guide'
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'This document describes how to connect to ClickHouse Cloud using G
sidebar_label: 'GCP private service connect'
slug: /manage/security/gcp-private-service-connect
doc_type: 'guide'
keywords: ['Private Service Connect']
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'Private networking'
hide_title: true
description: 'Table of contents page for the ClickHouse Cloud private networking section'
doc_type: 'landing-page'
keywords: ['private networking', 'network security', 'vpc', 'connectivity', 'cloud features']
---

# Private networking
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/guides/security/04_cmek.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ slug: /cloud/security/cmek
title: 'Data encryption'
description: 'Learn more about data encryption in ClickHouse Cloud'
doc_type: 'guide'
keywords: ['ClickHouse Cloud', 'encryption', 'CMEK', 'KMS key poller']
---

import Image from '@theme/IdealImage';
Expand Down
Loading