diff --git a/docs/db-cloud-shared/clients/otlp-integration.md b/docs/db-cloud-shared/clients/otlp-integration.md index ed1519313..295336e8f 100644 --- a/docs/db-cloud-shared/clients/otlp-integration.md +++ b/docs/db-cloud-shared/clients/otlp-integration.md @@ -7,7 +7,7 @@ To send OpenTelemetry Metrics to GreptimeDB through OpenTelemetry SDK libraries, * URL: `https:///v1/otlp/v1/metrics` * Headers: * `X-Greptime-DB-Name`: `` - * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/operations/authentication) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication) + * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/deployments/authentication) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication) The request uses binary protobuf to encode the payload, so you need to use packages that support `HTTP/protobuf`. For example, in Node.js, you can use [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto); in Go, you can use [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp); in Java, you can use [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp); and in Python, you can use [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/). diff --git a/docs/getting-started/installation/greptimedb-cluster.md b/docs/getting-started/installation/greptimedb-cluster.md index 2993ff752..5b634d8e1 100644 --- a/docs/getting-started/installation/greptimedb-cluster.md +++ b/docs/getting-started/installation/greptimedb-cluster.md @@ -35,7 +35,7 @@ By default, the data will be stored in `/tmp/greptimedb-cluster-docker-compose`. ## Deploy the GreptimeDB cluster in Kubernetes -Please refer to [Deploy on Kubernetes](/user-guide/operations/deploy-on-kubernetes/overview.md). +Please refer to [Deploy on Kubernetes](/user-guide/deployments/deploy-on-kubernetes/overview.md). ## Next Steps diff --git a/docs/getting-started/installation/greptimedb-standalone.md b/docs/getting-started/installation/greptimedb-standalone.md index 91dcc0e90..94e38a183 100644 --- a/docs/getting-started/installation/greptimedb-standalone.md +++ b/docs/getting-started/installation/greptimedb-standalone.md @@ -1,6 +1,6 @@ # GreptimeDB Standalone -We use the simplest configuration for you to get started. For a comprehensive list of configurations available in GreptimeDB, see the [configuration documentation](/user-guide/operations/configuration.md). +We use the simplest configuration for you to get started. For a comprehensive list of configurations available in GreptimeDB, see the [configuration documentation](/user-guide/deployments/configuration.md). ## Binary @@ -120,7 +120,7 @@ docker run -p 0.0.0.0:4000-4003:4000-4003 \ -You can also refer to the [Configuration](/user-guide/operations/configuration.md) document to modify the bind address in the configuration file. +You can also refer to the [Configuration](/user-guide/deployments/configuration.md) document to modify the bind address in the configuration file. ## Next Steps diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index fbbb11964..afbdb1a3b 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -12,7 +12,7 @@ In this quick start document, we use SQL for simplicity. If your GreptimeDB instance is running on `127.0.0.1` with the MySQL client default port `4002` or the PostgreSQL client default port `4003`, you can connect to GreptimeDB using the following commands. -By default, GreptimeDB does not have [authentication](/user-guide/operations/authentication.md) enabled. +By default, GreptimeDB does not have [authentication](/user-guide/deployments/authentication.md) enabled. You can connect to the database without providing a username and password in this section. ```shell diff --git a/docs/greptimecloud/integrations/otlp.md b/docs/greptimecloud/integrations/otlp.md index f98e728bd..48bee058f 100644 --- a/docs/greptimecloud/integrations/otlp.md +++ b/docs/greptimecloud/integrations/otlp.md @@ -9,7 +9,7 @@ To send OpenTelemetry Metrics to GreptimeDB through OpenTelemetry SDK libraries, * URL: `https:///v1/otlp/v1/metrics` * Headers: * `X-Greptime-DB-Name`: `` - * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/operations/authentication) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication) + * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/deployments/authentication) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication) The request uses binary protobuf to encode the payload, so you need to use packages that support `HTTP/protobuf`. For example, in Node.js, you can use [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto); in Go, you can use [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp); in Java, you can use [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp); and in Python, you can use [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/). diff --git a/docs/reference/command-lines.md b/docs/reference/command-lines.md index 8fd900e11..767f49671 100644 --- a/docs/reference/command-lines.md +++ b/docs/reference/command-lines.md @@ -105,7 +105,7 @@ greptime frontend start --help - `--tls-cert-path `: The TLS public key file path; - `--tls-key-path `: The TLS private key file path; - `--tls-mode `: TLS Mode; -- `--user-provider `: You can refer [authentication](/user-guide/operations/authentication.md); +- `--user-provider `: You can refer [authentication](/user-guide/deployments/authentication.md); ### Flownode subcommand options @@ -149,7 +149,7 @@ Starts GreptimeDB in standalone mode with customized configurations: greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml ``` -The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). +The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/deployments/configuration.md). To start GreptimeDB in distributed mode, you need to start each component separately. The following commands show how to start each component with customized configurations or command line arguments. diff --git a/docs/reference/sql/create.md b/docs/reference/sql/create.md index 42b403939..5a285e482 100644 --- a/docs/reference/sql/create.md +++ b/docs/reference/sql/create.md @@ -92,7 +92,7 @@ Users can add table options by using `WITH`. The valid options contain the follo | Option | Description | Value | | ------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ttl` | The storage time of the table data | String value, such as `'60m'`, `'1h'` for one hour, `'14d'` for 14 days etc. Supported time units are: `s` / `m` / `h` / `d` | -| `storage` | The name of the table storage engine provider | String value, such as `S3`, `Gcs`, etc. It must be configured in `[[storage.providers]]`, see [configuration](/user-guide/operations/configuration.md#storage-engine-provider). | +| `storage` | The name of the table storage engine provider | String value, such as `S3`, `Gcs`, etc. It must be configured in `[[storage.providers]]`, see [configuration](/user-guide/deployments/configuration.md#storage-engine-provider). | | `compaction.type` | Compaction strategy of the table | String value. Only `twcs` is allowed. | | `compaction.twcs.max_active_window_files` | Max num of files that can be kept in active writing time window | String value, such as '8'. Only available when `compaction.type` is `twcs`. You can refer to this [document](https://cassandra.apache.org/doc/latest/cassandra/managing/operating/compaction/twcs.html) to learn more about the `twcs` compaction strategy. | | `compaction.twcs.max_inactive_window_files` | Max num of files that can be kept in inactive time window. | String value, such as '1'. Only available when `compaction.type` is `twcs`. | diff --git a/docs/user-guide/cluster.md b/docs/user-guide/cluster.md index 95acd6d0d..34a77bb47 100644 --- a/docs/user-guide/cluster.md +++ b/docs/user-guide/cluster.md @@ -2,7 +2,7 @@ ## Create a cluster -Please refer to [Kubernetes](./operations/deploy-on-kubernetes/overview.md) to get the information about creating a Kubernetes cluster. +Please refer to [Kubernetes](./deployments/deploy-on-kubernetes/overview.md) to get the information about creating a Kubernetes cluster. ## Distributed Read/Write diff --git a/docs/user-guide/concepts/features-that-you-concern.md b/docs/user-guide/concepts/features-that-you-concern.md index 567f415e2..c715be7ca 100644 --- a/docs/user-guide/concepts/features-that-you-concern.md +++ b/docs/user-guide/concepts/features-that-you-concern.md @@ -42,7 +42,7 @@ Since 0.8, GreptimeDB added a new function called `Flow`, which is used for cont ## Can I store data in object storage in the cloud? Yes, GreptimeDB's data access layer is based on [OpenDAL](https://github.com/apache/incubator-opendal), which supports most kinds of object storage services. -The data can be stored in cost-effective cloud storage services such as AWS S3 or Azure Blob Storage, please refer to storage configuration guide [here](./../operations/configuration.md#storage-options). +The data can be stored in cost-effective cloud storage services such as AWS S3 or Azure Blob Storage, please refer to storage configuration guide [here](./../deployments/configuration.md#storage-options). GreptimeDB also offers a fully-managed cloud service [GreptimeCloud](https://greptime.com/product/cloud) to help you manage data in the cloud. diff --git a/docs/user-guide/concepts/storage-location.md b/docs/user-guide/concepts/storage-location.md index 05209309c..090ad18f7 100644 --- a/docs/user-guide/concepts/storage-location.md +++ b/docs/user-guide/concepts/storage-location.md @@ -24,14 +24,14 @@ The storage file structure of GreptimeDB includes of the following: ``` - `metadata`: The internal metadata directory that keeps catalog, database and table info, procedure states, etc. In cluster mode, this directory does not exist, because all those states including region route info are saved in `Metasrv`. -- `data`: The files in data directory store time series data and index files of GreptimeDB. To customize this path, please refer to [Storage option](../operations/configuration.md#storage-options). The directory is organized in a two-level structure of catalog and schema. +- `data`: The files in data directory store time series data and index files of GreptimeDB. To customize this path, please refer to [Storage option](../deployments/configuration.md#storage-options). The directory is organized in a two-level structure of catalog and schema. - `logs`: The log files contains all the logs of operations in GreptimeDB. - `wal`: The wal directory contains the write-ahead log files. - `index_intermediate`: the temporary intermediate data while indexing. ## Cloud storage -The `data` directory in the file structure can be stored in cloud storage. Please refer to [Storage option](../operations/configuration.md#storage-options) for more details. +The `data` directory in the file structure can be stored in cloud storage. Please refer to [Storage option](../deployments/configuration.md#storage-options) for more details. Please note that only storing the data directory in object storage is not sufficient to ensure data reliability and disaster recovery. The `wal` and `metadata` also need to be considered for disaster recovery. Please refer to the [disaster recovery documentation](/user-guide/operations/disaster-recovery/overview.md). diff --git a/docs/user-guide/operations/authentication.md b/docs/user-guide/deployments/authentication.md similarity index 100% rename from docs/user-guide/operations/authentication.md rename to docs/user-guide/deployments/authentication.md diff --git a/docs/user-guide/operations/configuration.md b/docs/user-guide/deployments/configuration.md similarity index 99% rename from docs/user-guide/operations/configuration.md rename to docs/user-guide/deployments/configuration.md index 6a54c1900..e4c0c9e1c 100644 --- a/docs/user-guide/operations/configuration.md +++ b/docs/user-guide/deployments/configuration.md @@ -386,9 +386,9 @@ default_ratio = 1.0 - `enable_otlp_tracing`: whether to turn on tracing, not turned on by default. - `otlp_endpoint`: Export the target endpoint of tracing using gRPC-based OTLP protocol, the default value is `localhost:4317`. - `append_stdout`: Whether to append logs to stdout. Defaults to `true`. -- `tracing_sample_ratio`: This field can configure the sampling rate of tracing. How to use `tracing_sample_ratio`, please refer to [How to configure tracing sampling rate](./tracing.md#guide-how-to-configure-tracing-sampling-rate). +- `tracing_sample_ratio`: This field can configure the sampling rate of tracing. How to use `tracing_sample_ratio`, please refer to [How to configure tracing sampling rate](/user-guide/operations/tracing.md#guide-how-to-configure-tracing-sampling-rate). -How to use distributed tracing, please reference [Tracing](./tracing.md#tutorial-use-jaeger-to-trace-greptimedb) +How to use distributed tracing, please reference [Tracing](/user-guide/operations/tracing.md#tutorial-use-jaeger-to-trace-greptimedb) ### Region engine options diff --git a/docs/user-guide/operations/deploy-on-kubernetes/deploy-greptimedb-cluster.md b/docs/user-guide/deployments/deploy-on-kubernetes/deploy-greptimedb-cluster.md similarity index 100% rename from docs/user-guide/operations/deploy-on-kubernetes/deploy-greptimedb-cluster.md rename to docs/user-guide/deployments/deploy-on-kubernetes/deploy-greptimedb-cluster.md diff --git a/docs/user-guide/operations/deploy-on-kubernetes/destroy-cluster.md b/docs/user-guide/deployments/deploy-on-kubernetes/destroy-cluster.md similarity index 100% rename from docs/user-guide/operations/deploy-on-kubernetes/destroy-cluster.md rename to docs/user-guide/deployments/deploy-on-kubernetes/destroy-cluster.md diff --git a/docs/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md b/docs/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md similarity index 99% rename from docs/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md rename to docs/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md index e64add62d..303e3e585 100644 --- a/docs/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md +++ b/docs/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md @@ -23,7 +23,8 @@ helm search repo greptimedb-operator ``` You should see output similar to this: -``` + +```shell NAME CHART VERSION APP VERSION DESCRIPTION greptime/greptimedb-operator 0.2.3 0.1.0-alpha.29 The greptimedb-operator Helm chart for Kubernetes. ``` diff --git a/docs/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md b/docs/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md similarity index 100% rename from docs/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md rename to docs/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md diff --git a/docs/user-guide/operations/deploy-on-kubernetes/overview.md b/docs/user-guide/deployments/deploy-on-kubernetes/overview.md similarity index 100% rename from docs/user-guide/operations/deploy-on-kubernetes/overview.md rename to docs/user-guide/deployments/deploy-on-kubernetes/overview.md diff --git a/docs/user-guide/deployments/overview.md b/docs/user-guide/deployments/overview.md new file mode 100644 index 000000000..d54438c09 --- /dev/null +++ b/docs/user-guide/deployments/overview.md @@ -0,0 +1,28 @@ +# Overview + +## Configuration + +Before deploying GreptimeDB, you need to [configure the server](configuration.md) to meet your requirements. This includes setting up protocol options, storage options, and more. + +## Authentication + +By default, GreptimeDB does not have authentication enabled. Learn how to [configure authentication](authentication.md) for your deployment manually. + +## Deploy on Kubernetes + +The step-by-step instructions for [deploying GreptimeDB on a Kubernetes cluster](./deploy-on-kubernetes/overview.md). + +## Run on Android + +Learn how to [run GreptimeDB on Android devices](run-on-android.md). + +## Capacity plan + +Understand how to [plan for capacity](/user-guide/operations/capacity-plan.md) to ensure your GreptimeDB deployment can handle your workload. + +## GreptimeCloud + +Instead of managing your own GreptimeDB cluster, +you can use [GreptimeCloud](https://greptime.cloud) to manage GreptimeDB instances, monitor metrics, and set up alerts. +GreptimeCloud is a cloud service powered by fully-managed serverless GreptimeDB, providing a scalable and efficient solution for time-series data platforms and Prometheus backends. +For more information, see the [GreptimeCloud documentation](/greptimecloud/overview.md). diff --git a/docs/user-guide/operations/run-on-android.md b/docs/user-guide/deployments/run-on-android.md similarity index 100% rename from docs/user-guide/operations/run-on-android.md rename to docs/user-guide/deployments/run-on-android.md diff --git a/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md b/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md index 01e020ab6..d6abd226c 100644 --- a/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md +++ b/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md @@ -16,7 +16,7 @@ For more information, refer to [Automatic Schema Generation](/user-guide/ingest- ## Connect to database -If you have set the [`--user-provider` configuration](/user-guide/operations/authentication.md) when starting GreptimeDB, +If you have set the [`--user-provider` configuration](/user-guide/deployments/authentication.md) when starting GreptimeDB, you will need to provide a username and password to connect to GreptimeDB. The following example shows how to set the username and password when using the library to connect to GreptimeDB. diff --git a/docs/user-guide/ingest-data/for-iot/influxdb-line-protocol.md b/docs/user-guide/ingest-data/for-iot/influxdb-line-protocol.md index eeb4faa1d..b85381ec2 100644 --- a/docs/user-guide/ingest-data/for-iot/influxdb-line-protocol.md +++ b/docs/user-guide/ingest-data/for-iot/influxdb-line-protocol.md @@ -73,7 +73,7 @@ curl -i -XPOST "http://localhost:4000/v1/influxdb/write?db=public" \ #### Authentication GreptimeDB is compatible with InfluxDB's line protocol authentication format, both V1 and V2. -If you have [configured authentication](/user-guide/operations/authentication.md) in GreptimeDB, you need to provide the username and password in the HTTP request. +If you have [configured authentication](/user-guide/deployments/authentication.md) in GreptimeDB, you need to provide the username and password in the HTTP request. diff --git a/docs/user-guide/ingest-data/for-observerbility/prometheus.md b/docs/user-guide/ingest-data/for-observerbility/prometheus.md index 1affbc7ee..8ce987d6a 100644 --- a/docs/user-guide/ingest-data/for-observerbility/prometheus.md +++ b/docs/user-guide/ingest-data/for-observerbility/prometheus.md @@ -24,9 +24,9 @@ remote_read: # password: greptime_pwd ``` -- The host and port in the URL represent the GreptimeDB server. In this example, the server is running on `localhost:4000`. You can replace it with your own server address. For the HTTP protocol configuration in GreptimeDB, please refer to the [protocol options](/user-guide/operations/configuration.md#protocol-options). +- The host and port in the URL represent the GreptimeDB server. In this example, the server is running on `localhost:4000`. You can replace it with your own server address. For the HTTP protocol configuration in GreptimeDB, please refer to the [protocol options](/user-guide/deployments/configuration.md#protocol-options). - The `db` parameter in the URL represents the database to which we want to write data. It is optional. By default, the database is set to `public`. -- `basic_auth` is the authentication configuration. Fill in the username and password if GreptimeDB authentication is enabled. Please refer to the [authentication document](/user-guide/operations/authentication.md). +- `basic_auth` is the authentication configuration. Fill in the username and password if GreptimeDB authentication is enabled. Please refer to the [authentication document](/user-guide/deployments/authentication.md). ## Data Model diff --git a/docs/user-guide/ingest-data/for-observerbility/vector.md b/docs/user-guide/ingest-data/for-observerbility/vector.md index 72a931b6f..4107b7383 100644 --- a/docs/user-guide/ingest-data/for-observerbility/vector.md +++ b/docs/user-guide/ingest-data/for-observerbility/vector.md @@ -27,7 +27,7 @@ password = "" ``` GreptimeDB uses gRPC to communicate with Vector, so the default port for the Vector sink is `4001`. -If you have changed the default gRPC port when starting GreptimeDB with [custom configurations](/user-guide/operations/configuration.md#configuration-file), use your own port instead. +If you have changed the default gRPC port when starting GreptimeDB with [custom configurations](/user-guide/deployments/configuration.md#configuration-file), use your own port instead. diff --git a/docs/user-guide/integrations/metabase.md b/docs/user-guide/integrations/metabase.md index c69a69b3f..48c3fe3c0 100644 --- a/docs/user-guide/integrations/metabase.md +++ b/docs/user-guide/integrations/metabase.md @@ -23,6 +23,6 @@ information. - Use Greptime's Postgres protocol port `4003` as port. If you changed the defaults, use you own settings. - Username and password are optional if you didn't enable - [authentication](/user-guide/operations/authentication.md). + [authentication](/user-guide/deployments/authentication.md). - Use `public` as default *Database name*. When using GreptimeCloud instance, use the database name from your instance. diff --git a/docs/user-guide/integrations/superset.md b/docs/user-guide/integrations/superset.md index 9f0e4c5d8..f77d7f227 100644 --- a/docs/user-guide/integrations/superset.md +++ b/docs/user-guide/integrations/superset.md @@ -47,7 +47,7 @@ greptimedb://:@:/ ``` - Ignore `:@` if you don't have - [authentication](/user-guide/operations/authentication.md) enabled. + [authentication](/user-guide/deployments/authentication.md) enabled. - Use `4003` for default port (this extension uses Postgres protocol). - Use `public` as default `database`. When using GreptimeCloud instance, use the database name from your instance. diff --git a/docs/user-guide/operations/admin.md b/docs/user-guide/operations/admin.md index 575041f8c..9ca956d67 100644 --- a/docs/user-guide/operations/admin.md +++ b/docs/user-guide/operations/admin.md @@ -5,9 +5,9 @@ This document addresses strategies and practices used in the operation of Grepti ## Database/Cluster management * [Installation](/getting-started/installation/overview.md) for GreptimeDB and the [g-t-control](/reference/gtctl.md) command line tool. -* Database Configuration, please read the [Configuration](./configuration.md) reference. -* [Monitoring](./monitoring.md) and [Tracing](./tracing.md) for GreptimeDB. -* GreptimeDB [Disaster Recovery](./disaster-recovery/overview.md). +* Database Configuration, please read the [Configuration](/user-guide/deployments/configuration.md) reference. +* [Monitoring](/user-guide/operations/monitoring.md) and [Tracing](/user-guide/operations/tracing.md) for GreptimeDB. +* GreptimeDB [Disaster Recovery](/user-guide/operations/disaster-recovery/overview.md). ### Runtime information diff --git a/docs/user-guide/operations/capacity-plan.md b/docs/user-guide/operations/capacity-plan.md index d603ff7b8..844259422 100644 --- a/docs/user-guide/operations/capacity-plan.md +++ b/docs/user-guide/operations/capacity-plan.md @@ -13,7 +13,7 @@ there are several key considerations: - Data retention policy - Hardware costs -To monitor the various metrics of GreptimeDB, please refer to [Monitoring](./monitoring.md). +To monitor the various metrics of GreptimeDB, please refer to [Monitoring](/user-guide/operations/monitoring.md). ## CPU @@ -42,7 +42,7 @@ This allows GreptimeDB to store large amounts of data in a significantly smaller Data can be stored either in a local file system or in cloud storage, such as AWS S3. FOr more information on storage options, -please refer to the [storage configuration](./configuration.md#storage-options) documentation. +please refer to the [storage configuration](/user-guide/deployments/configuration.md#storage-options) documentation. Cloud storage is highly recommended for data storage due to its simplicity in managing storage. With cloud storage, only about 200GB of local storage space is needed for query-related caches and Write-Ahead Log (WAL). diff --git a/docs/user-guide/operations/monitoring.md b/docs/user-guide/operations/monitoring.md index 025be3670..85c75b607 100644 --- a/docs/user-guide/operations/monitoring.md +++ b/docs/user-guide/operations/monitoring.md @@ -46,7 +46,7 @@ the `docker run` command. You can also save metrics to GreptimeDB itself for convenient querying and analysis using SQL statements. This section provides some configuration examples. -For more details about configuration, please refer to the [Monitor metrics options](./configuration.md#monitor-metrics-options). +For more details about configuration, please refer to the [Monitor metrics options](/user-guide/deployments/configuration.md#monitor-metrics-options). ### Standalone diff --git a/docs/user-guide/operations/overview.md b/docs/user-guide/operations/overview.md index 0024c91b6..e13f12f68 100644 --- a/docs/user-guide/operations/overview.md +++ b/docs/user-guide/operations/overview.md @@ -1,10 +1,7 @@ # Overview * [Administration](./admin.md) -* [Configuration](./configuration.md) * [Capacity Plan](./capacity-plan.md) -* [Kubernetes](./deploy-on-kubernetes/overview.md) -* [Running on Android](./run-on-android.md) * [Disaster Recovery](./disaster-recovery/overview.md) * [Monitoring](./monitoring.md) * [Tracing](./tracing.md) diff --git a/docs/user-guide/operations/region-failover.md b/docs/user-guide/operations/region-failover.md index 15fd46888..b49349648 100644 --- a/docs/user-guide/operations/region-failover.md +++ b/docs/user-guide/operations/region-failover.md @@ -7,10 +7,10 @@ Region Failover provides the ability to recover regions from region failures wit This feature is only available on GreptimeDB running on distributed mode and - Using Kafka WAL -- Using [shared storage](/user-guide/operations/configuration.md#storage-options) (e.g., AWS S3) +- Using [shared storage](/user-guide/deployments/configuration.md#storage-options) (e.g., AWS S3) ### Via configuration file -Set the `enable_region_failover=true` in [metasrv](/user-guide/operations/configuration.md#metasrv-only-configuration) configuration file. +Set the `enable_region_failover=true` in [metasrv](/user-guide/deployments/configuration.md#metasrv-only-configuration) configuration file. ### Via GreptimeDB Operator @@ -38,7 +38,7 @@ The data belonging to a specific region consists of data files plus data in the Although multiple regions share the same topic, allowing the Datanode to support more regions, the cost of this approach is read amplification during WAL replay. -For example, configure 128 topics for [metasrv](/user-guide/operations/configuration.md#metasrv-only-configuration), and if the whole cluster holds 1024 regions (physical regions), every 8 regions will share one topic. +For example, configure 128 topics for [metasrv](/user-guide/deployments/configuration.md#metasrv-only-configuration), and if the whole cluster holds 1024 regions (physical regions), every 8 regions will share one topic. ![Read Amplification](/remote-wal-read-amplification.png) diff --git a/docs/user-guide/operations/region-migration.md b/docs/user-guide/operations/region-migration.md index 480f99295..8280cf375 100644 --- a/docs/user-guide/operations/region-migration.md +++ b/docs/user-guide/operations/region-migration.md @@ -5,7 +5,7 @@ Region Migration allows users to move regions between the Datanode. :::warning Warning This feature is only available on GreptimeDB running on distributed mode and - Using Kafka WAL -- Using [shared storage](/user-guide/operations/configuration.md#storage-options) (e.g., AWS S3) +- Using [shared storage](/user-guide/deployments/configuration.md#storage-options) (e.g., AWS S3) Otherwise, you can't perform a region migration. ::: diff --git a/docs/user-guide/operations/remote-wal/quick-start.md b/docs/user-guide/operations/remote-wal/quick-start.md index 82ba2bac9..69cc8baee 100644 --- a/docs/user-guide/operations/remote-wal/quick-start.md +++ b/docs/user-guide/operations/remote-wal/quick-start.md @@ -72,7 +72,7 @@ To avoid accidently exit the Docker container, you may want to run it in the "de the `docker run` command. ::: -We use the [environment variables](/user-guide/operations/configuration.md#environment-variable) to specify the provider: +We use the [environment variables](/user-guide/deployments/configuration.md#environment-variable) to specify the provider: - `GREPTIMEDB_STANDALONE__WAL__PROVIDER`: Set `kafka` to use Kafka remote WAL; - `GREPTIMEDB_STANDALONE__WAL__BROKER_ENDPOINTS`: Specify the advertised listeners for all brokers in the Kafka cluster. In this example, we will use the Kafka container name, and the bridge network will resolve it into IPv4; diff --git a/docs/user-guide/operations/tracing.md b/docs/user-guide/operations/tracing.md index e60189cb8..67d6d78e5 100644 --- a/docs/user-guide/operations/tracing.md +++ b/docs/user-guide/operations/tracing.md @@ -2,7 +2,7 @@ GreptimeDB supports distributed tracing. GreptimeDB exports all collected spans using the gRPC-based OTLP protocol. Users can use [Jaeger](https://www.jaegertracing.io/), [Tempo](https://grafana.com/oss/tempo/) and other OTLP protocol backends that support gRPC to collect the span instrument by GreptimeDB. -In the [logging section](./configuration.md#logging-options) in the configuration, there are descriptions of configuration items related to tracing, [standalone.example.toml](https://github.com/GreptimeTeam/greptimedb/blob/main/config/standalone.example.toml) provide a reference configuration in the logging section. +In the [logging section](/user-guide/deployments/configuration.md#logging-options) in the configuration, there are descriptions of configuration items related to tracing, [standalone.example.toml](https://github.com/GreptimeTeam/greptimedb/blob/main/config/standalone.example.toml) provide a reference configuration in the logging section. ## Tutorial: Use Jaeger to trace GreptimeDB diff --git a/docs/user-guide/protocols/mysql.md b/docs/user-guide/protocols/mysql.md index e17f2a665..a7157d8fb 100644 --- a/docs/user-guide/protocols/mysql.md +++ b/docs/user-guide/protocols/mysql.md @@ -8,8 +8,8 @@ You can connect to GreptimeDB using MySQL via port `4002`. mysql -h -P 4002 -u -p ``` -- For how to setup username and password for GreptimeDB, please refer to [Authentication](/user-guide/operations/authentication.md). -- If you want to use other ports for MySQL, please refer to [Protocol options](/user-guide/operations/configuration.md#protocol-options) in the configuration document. +- For how to setup username and password for GreptimeDB, please refer to [Authentication](/user-guide/deployments/authentication.md). +- If you want to use other ports for MySQL, please refer to [Protocol options](/user-guide/deployments/configuration.md#protocol-options) in the configuration document. ## Table management diff --git a/docs/user-guide/protocols/postgresql.md b/docs/user-guide/protocols/postgresql.md index 4eb796a25..74965a335 100644 --- a/docs/user-guide/protocols/postgresql.md +++ b/docs/user-guide/protocols/postgresql.md @@ -9,8 +9,8 @@ Simply add the `-U` argument to your command, followed by your username and pass psql -h -p 4003 -U -d public ``` -- For how to setup username and password for GreptimeDB, please refer to [Authentication](/user-guide/operations/authentication.md). -- If you want to use other ports for PostgreSQL, please refer to [Protocol options](/user-guide/operations/configuration.md#protocol-options) in the configuration document. +- For how to setup username and password for GreptimeDB, please refer to [Authentication](/user-guide/deployments/authentication.md). +- If you want to use other ports for PostgreSQL, please refer to [Protocol options](/user-guide/deployments/configuration.md#protocol-options) in the configuration document. ## Table management diff --git a/i18n/zh/docusaurus-plugin-content-docs/current.json b/i18n/zh/docusaurus-plugin-content-docs/current.json index d6e779212..ba5fc9818 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh/docusaurus-plugin-content-docs/current.json @@ -47,6 +47,10 @@ "message": "运维操作", "description": "The label for category Operations in sidebar docs" }, + "sidebar.docs.category.Deployments": { + "message": "部署", + "description": "The label for category Deployments in sidebar docs" + }, "sidebar.docs.category.Deploy on Kubernetes": { "message": "部署到 Kubernetes", "description": "The label for category Deploy on Kubernetes in sidebar docs" diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/clients/otlp-integration.md b/i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/clients/otlp-integration.md index 09bac4d86..2097b6579 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/clients/otlp-integration.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/clients/otlp-integration.md @@ -7,7 +7,7 @@ GreptimeDB 通过原生支持 [OTLP/HTTP](https://opentelemetry.io/docs/specs/ot * URL: `https:///v1/otlp/v1/metrics` * Headers: * `X-Greptime-DB-Name`: `` -* `Authorization`: `Basic` 认证，是 `:` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.cn/user-guide/operations/authentication) 和 [HTTP API](https://docs.greptime.cn/user-guide/protocols/http#authentication)。 +* `Authorization`: `Basic` 认证，是 `:` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.cn/user-guide/deployments/authentication) 和 [HTTP API](https://docs.greptime.cn/user-guide/protocols/http#authentication)。 请求中使用 binary protobuf 编码 payload，因此你需要使用支持 `HTTP/protobuf` 的包。例如，在 Node.js 中，可以使用 [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto)；在 Go 中，可以使用 [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)；在 Java 中，可以使用 [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp)；在 Python 中，可以使用 [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/)。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-cluster.md b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-cluster.md index 93a39ed15..5895e54e0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-cluster.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-cluster.md @@ -37,7 +37,7 @@ docker compose -f ./cluster-with-etcd.yaml down ## 在 Kubernetes 中部署 GreptimeDB 集群 -请参考 [在 Kubernetes 上部署](/user-guide/operations/deploy-on-kubernetes/overview.md)。 +请参考 [在 Kubernetes 上部署](/user-guide/deployments/deploy-on-kubernetes/overview.md)。 ## 下一步 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-standalone.md b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-standalone.md index a04847133..9400ce389 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-standalone.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation/greptimedb-standalone.md @@ -2,7 +2,7 @@ ## 安装 -我们先通过最简单的配置来开始。有关 GreptimeDB 中可用的所有配置选项的详细列表，请参考[配置文档](/user-guide/operations/configuration.md)。 +我们先通过最简单的配置来开始。有关 GreptimeDB 中可用的所有配置选项的详细列表，请参考[配置文档](/user-guide/deployments/configuration.md)。 ### 二进制 @@ -121,7 +121,7 @@ docker run -p 0.0.0.0:4000-4003:4000-4003 \ -你也可以参考[配置 GreptimeDB](/user-guide/operations/configuration.md)文档在配置文件中修改绑定的地址。 +你也可以参考[配置 GreptimeDB](/user-guide/deployments/configuration.md)文档在配置文件中修改绑定的地址。 ## 下一步 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md index fede90767..1923e6e45 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md @@ -13,7 +13,7 @@ GreptimeDB 支持[多种协议](/user-guide/protocols/overview.md)与数据库 并且使用 MySQL 客户端默认端口 `4002` 或 PostgreSQL 客户端默认端口 `4003`， 你可以使用以下命令连接到数据库。 -GreptimeDB 默认不开启[鉴权认证](/user-guide/operations/authentication.md)。 +GreptimeDB 默认不开启[鉴权认证](/user-guide/deployments/authentication.md)。 在本章节中你可以在连接数据库时不提供用户名密码。 ```shell diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md index dc6f34543..9f19a92cc 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md @@ -9,7 +9,7 @@ To send OpenTelemetry Metrics to GreptimeDB through OpenTelemetry SDK libraries, * URL: `https:///v1/otlp/v1/metrics` * Headers: * `X-Greptime-DB-Name`: `` - * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/operations/authentication) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication) + * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/deployments/authentication) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication) The request uses binary protobuf to encode the payload, so you need to use packages that support `HTTP/protobuf`. For example, in Node.js, you can use [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto); in Go, you can use [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp); in Java, you can use [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp); and in Python, you can use [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/). diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines.md b/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines.md index b6118fefc..b0414f5a2 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines.md @@ -105,7 +105,7 @@ greptime frontend start --help - `--tls-cert-path `: TLS 公钥文件地址 - `--tls-key-path `: TLS 私钥文件地址 - `--tls-mode `: TLS 模式 -- `--user-provider `: 参考 [鉴权](/user-guide/operations/authentication.md); +- `--user-provider `: 参考 [鉴权](/user-guide/deployments/authentication.md); ### Flownode 子命令选项 @@ -149,7 +149,7 @@ greptime standalone start --help greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml ``` -`standalone.example.toml` 配置文件来自 `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` 仓库的 `config` 目录。您可以在那里找到更多示例配置文件。使用 `-c` 选项可以指定配置文件，有关更多信息，更多信息请查看[配置](../user-guide/operations/configuration.md)。 +`standalone.example.toml` 配置文件来自 `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` 仓库的 `config` 目录。您可以在那里找到更多示例配置文件。使用 `-c` 选项可以指定配置文件，有关更多信息，更多信息请查看[配置](../user-guide/deployments/configuration.md)。 为了以分布式模式启动 GreptimeDB，您需要分别启动每个组件。以下命令显示了如何使用自定义配置或命令行参数启动每个组件： diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/create.md b/i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/create.md index 7d1caf4b9..42f9dd436 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/create.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/create.md @@ -94,7 +94,7 @@ CREATE TABLE [IF NOT EXISTS] [db.]table_name | 选项 | 描述 | 值 | | ------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `ttl` | 表数据的存储时间 | 字符串值，例如 `'60m'`, `'1h'` 代表 1 小时， `'14d'` 代表 14 天等。支持的时间单位有：`s` / `m` / `h` / `d` | -| `storage` | 自定义表的存储引擎，存储引擎提供商的名字 | 字符串，类似 `S3`、`Gcs` 等。 必须在 `[[storage.providers]]` 列表里配置, 参考 [configuration](/user-guide/operations/configuration.md#存储引擎提供商)。 | +| `storage` | 自定义表的存储引擎，存储引擎提供商的名字 | 字符串，类似 `S3`、`Gcs` 等。 必须在 `[[storage.providers]]` 列表里配置, 参考 [configuration](/user-guide/deployments/configuration.md#存储引擎提供商)。 | | `compaction.type` | Compaction 策略 | 字符串值. 只支持 `twcs`。你可以阅读这篇[文章](https://cassandra.apache.org/doc/latest/cassandra/managing/operating/compaction/twcs.html)来了解 `twcs` compaction 策略 | | `compaction.twcs.max_active_window_files` | 当前活跃时间窗口内的最大文件数 | 字符串值，如 '8'。只在 `compaction.type` 为 `twcs` 时可用 | | `compaction.twcs.max_inactive_window_files` | 非活跃时间窗口内的最大文件数 | 字符串值，如 '1'。只在 `compaction.type` 为 `twcs` 时可用 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/cluster.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/cluster.md index 51161d5e1..6f0732031 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/cluster.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/cluster.md @@ -2,7 +2,7 @@ ## 创建一个集群 -请参考 [Kubernetes](./operations/deploy-on-kubernetes/overview.md) 以获得关于创建 Kubernetes 集群的信息。 +请参考 [Kubernetes](./deployments/deploy-on-kubernetes/overview.md) 以获得关于创建 Kubernetes 集群的信息。 ## 分布式读/写 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md index e9ff36522..601c20c31 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md @@ -41,7 +41,7 @@ GreptimeDB 通过以下方式解决这个问题： ## 我可以在云的对象存储中存储数据吗？ 可以，GreptimeDB 的数据访问层基于 [OpenDAL](https://github.com/apache/incubator-opendal)，它支持大多数类型的对象存储服务。 -数据可以存储在如 AWS S3 或 Azure Blob Storage 等性价比高的云存储服务中，请参考这里的存储[配置指南](./../operations/configuration.md#storage-options)。 +数据可以存储在如 AWS S3 或 Azure Blob Storage 等性价比高的云存储服务中，请参考这里的存储[配置指南](./../deployments/configuration.md#storage-options)。 GreptimeDB 还提供一个完全托管的云服务 [GreptimeCloud](https://greptime.cn/product/cloud) 来帮助您管理云中的数据。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/storage-location.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/storage-location.md index d9418251f..6425ef9cd 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/storage-location.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/storage-location.md @@ -24,14 +24,14 @@ GreptimeDB 的存储文件结构包括以下内容： ``` - `metadata`: 内部元数据目录，保存 catatalog、数据库以及表的元信息、procedure 状态等内部状态。在集群模式下，此目录不存在，因为所有这些状态（包括区域路由信息）都保存在 `Metasrv` 中。 -- `data`: 存储 GreptimeDB 的实际的时间序列数据和索引文件。如果要自定义此路径，请参阅 [存储选项](../operations/configuration.md#storage-options)。该目录按照 catalog 和 schema 的两级结构组织。 +- `data`: 存储 GreptimeDB 的实际的时间序列数据和索引文件。如果要自定义此路径，请参阅 [存储选项](../deployments/configuration.md#storage-options)。该目录按照 catalog 和 schema 的两级结构组织。 - `logs`: GreptimeDB 日志文件目录。 - `wal`: 预写日志文件目录。 - `index_intermediate`: 索引构建和查询相关的的临时中间数据目录。 ## 云存储 -文件结构中的 `cluster` 和 `data` 目录可以存储在云存储中。请参考[存储选项](../operations/configuration.md#存储选项)了解更多细节。 +文件结构中的 `cluster` 和 `data` 目录可以存储在云存储中。请参考[存储选项](../deployments/configuration.md#存储选项)了解更多细节。 请注意，仅将 `data` 目录存储在对象存储中不足以确保数据可靠性和灾难恢复，`wal` 和 `metadata` 也需要考虑灾难恢复，更详细地请参阅[灾难恢复文档](/user-guide/operations/disaster-recovery/overview.md)。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/authentication.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/authentication.md similarity index 100% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/authentication.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/authentication.md diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/configuration.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md similarity index 99% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/configuration.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md index d2a33ef9b..f79e6704a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/configuration.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md @@ -375,9 +375,9 @@ default_ratio = 1.0 - `enable_otlp_tracing`：是否打开分布式追踪，默认不开启。 - `otlp_endpoint`：使用基于 gRPC 的 OTLP 协议导出 tracing 的目标端点，默认值为 `localhost:4317`。 - `append_stdout`：是否将日志打印到 stdout。默认是`true`。 -- `tracing_sample_ratio`：该字段可以配置 tracing 的采样率，如何使用 `tracing_sample_ratio`，请参考 [如何配置 tracing 采样率](./tracing.md#指南如何配置-tracing-采样率)。 +- `tracing_sample_ratio`：该字段可以配置 tracing 的采样率，如何使用 `tracing_sample_ratio`，请参考 [如何配置 tracing 采样率](/user-guide/operations/tracing.md#指南如何配置-tracing-采样率)。 -如何使用分布式追踪，请参考 [Tracing](./tracing.md#教程使用-jaeger-追踪-greptimedb-调用链路) +如何使用分布式追踪，请参考 [Tracing](/user-guide/operations/tracing.md#教程使用-jaeger-追踪-greptimedb-调用链路) ### Region 引擎选项 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/deploy-greptimedb-cluster.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/deploy-greptimedb-cluster.md similarity index 96% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/deploy-greptimedb-cluster.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/deploy-greptimedb-cluster.md index 173fd6136..fdcc6b088 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/deploy-greptimedb-cluster.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/deploy-greptimedb-cluster.md @@ -1,6 +1,6 @@ # 部署 GreptimeDB 集群 -在部署之前，请确保你已经在 Kubernetes 集群上安装了 [GreptimeDB Operator](./manage-greptimedb-operator/deploy-greptimedb-operator.md)。 +在部署之前，请确保你已经在 Kubernetes 集群上安装了 [GreptimeDB Operator](/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md)。 ## 使用 Helm 进行部署 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/destroy-cluster.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/destroy-cluster.md similarity index 100% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/destroy-cluster.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/destroy-cluster.md diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md similarity index 100% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md similarity index 100% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/overview.md similarity index 100% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/deploy-on-kubernetes/overview.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/overview.md diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/overview.md new file mode 100644 index 000000000..c6311ab5d --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/overview.md @@ -0,0 +1,31 @@ +# 概述 + +## 配置项 + +在部署 GreptimeDB 之前，你需要[配置服务器](configuration.md)以满足需求， +其中包括设置协议选项、存储选项等。 + +## 鉴权 + +GreptimeDB 默认不启用鉴权认证。 +了解如何为你的部署手动[配置鉴权](authentication.md)。 + +## 部署到 Kubernetes + +[在 Kubernetes 集群上部署 GreptimeDB](./deploy-on-kubernetes/overview.md)的逐步说明。 + +## 在 Android 上运行 + +[在 Android 设备上运行 GreptimeDB](run-on-android.md)的指南。 + +## 容量规划 + +了解如何[规划容量](/user-guide/operations/capacity-plan.md)以确保你的 GreptimeDB 部署能够处理你的工作负载。 + +## GreptimeCloud + +比起管理自己的 GreptimeDB 集群， +你可以使用 [GreptimeCloud](https://greptime.cloud) 来管理 GreptimeDB 实例、监控指标和设置警报。 +GreptimeCloud 是由完全托管的无服务器 GreptimeDB 提供支持的云服务，为时间序列数据平台和 Prometheus 后端提供了可扩展和高效的解决方案。 +有关更多信息，请参阅[GreptimeCloud 文档](/greptimecloud/overview.md)。 + diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/run-on-android.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/run-on-android.md similarity index 100% rename from i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/run-on-android.md rename to i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/run-on-android.md diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md index dc0d90adf..2e0908f0e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md @@ -15,7 +15,7 @@ GreptimeDB 提供了用于高吞吐量数据写入的 ingester 库。 ## 连接数据库 -如果你在启动 GreptimeDB 时设置了 [`--user-provider`](/user-guide/operations/authentication.md)， +如果你在启动 GreptimeDB 时设置了 [`--user-provider`](/user-guide/deployments/authentication.md)， 则需要提供用户名和密码才能连接到 GreptimeDB。 以下示例显示了使用 SDK 连接到 GreptimeDB 时如何设置用户名和密码。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/influxdb-line-protocol.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/influxdb-line-protocol.md index 41d96c73b..b352f60ef 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/influxdb-line-protocol.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/influxdb-line-protocol.md @@ -73,7 +73,7 @@ curl -i -XPOST "http://localhost:4000/v1/influxdb/write?db=public" \ #### 鉴权 GreptimeDB 与 InfluxDB 的行协议鉴权格式兼容，包括 V1 和 V2。 -如果你在 GreptimeDB 中[配置了鉴权](/user-guide/operations/authentication.md)，需要在 HTTP 请求中提供用户名和密码。 +如果你在 GreptimeDB 中[配置了鉴权](/user-guide/deployments/authentication.md)，需要在 HTTP 请求中提供用户名和密码。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/prometheus.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/prometheus.md index c0bb20094..60c9a58c5 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/prometheus.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/prometheus.md @@ -23,9 +23,9 @@ remote_read: # password: greptime_pwd ``` -- URL 中的 host 和 port 表示 GreptimeDB 服务器。在此示例中，服务器运行在 `localhost:4000` 上。你可以将其替换为你自己的服务器地址。有关 GreptimeDB 中 HTTP 协议的配置，请参阅 [协议选项](/user-guide/operations/configuration.md#protocol-options)。 +- URL 中的 host 和 port 表示 GreptimeDB 服务器。在此示例中，服务器运行在 `localhost:4000` 上。你可以将其替换为你自己的服务器地址。有关 GreptimeDB 中 HTTP 协议的配置，请参阅 [协议选项](/user-guide/deployments/configuration.md#protocol-options)。 - URL 中的 `db` 参数表示要写入的数据库。它是可选的。默认情况下，数据库设置为 `public`。 -- `basic_auth` 是身份鉴权配置。如果 GreptimeDB 启用了鉴权，请填写用户名和密码。请参阅 [鉴权认证文档](/user-guide/operations/authentication.md)。 +- `basic_auth` 是身份鉴权配置。如果 GreptimeDB 启用了鉴权，请填写用户名和密码。请参阅 [鉴权认证文档](/user-guide/deployments/authentication.md)。 ## 数据模型 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/vector.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/vector.md index 0b155c8b8..378970c13 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/vector.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observerbility/vector.md @@ -29,7 +29,7 @@ password = "" ``` GreptimeDB 使用 gRPC 与 Vector 进行通信，因此 Vector sink 的默认端口是 `4001`。 -如果你在使用 [自定义配置](/user-guide/operations/configuration.md#configuration-file) 启动 GreptimeDB 时更改了默认的 gRPC 端口，请使用你自己的端口。 +如果你在使用 [自定义配置](/user-guide/deployments/configuration.md#configuration-file) 启动 GreptimeDB 时更改了默认的 gRPC 端口，请使用你自己的端口。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/metabase.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/metabase.md index 7da0c711c..84b774064 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/metabase.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/metabase.md @@ -19,7 +19,7 @@ 进一步添加其他数据库信息： - 端口请填写 GreptimeDB 的 Postgres 协议端口 `4003`。 -- 如果没有开启[认证](/user-guide/operations/authentication.md)，用户名和密码字段 +- 如果没有开启[认证](/user-guide/deployments/authentication.md)，用户名和密码字段 是可选的。 - 默认填写 `public` 作为 *数据库名*。如果是使用 GreptimeCloud 的实例，可以从控制 台复制数据库名称。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/superset.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/superset.md index 9341afd83..4bb2be30a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/superset.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/integrations/superset.md @@ -45,7 +45,7 @@ pip install greptimedb-sqlalchemy greptimedb://:@:/ ``` -- 如果没有启动[认证](/user-guide/operations/authentication.md)，可以忽略 +- 如果没有启动[认证](/user-guide/deployments/authentication.md)，可以忽略 `:@` 部分。 - 默认端口 `4003` （我们用 PostgresSQL 协议通信）。 - 默认数据库 `public`。如果是使用 GreptimeCloud 实例，可以从控制台复制数据库名称。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/admin.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/admin.md index 5764edc34..e73f895b0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/admin.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/admin.md @@ -5,9 +5,9 @@ ## 数据库/集群管理 * GreptimeDB 的 [安装](/getting-started/installation/overview.md) 和 [g-t-control](/reference/gtctl.md) 命令行工具。 -* 数据库配置，请阅读 [配置](./configuration.md) 参考。 -* GreptimeDB 的 [监控](./monitoring.md) 和 [链路追踪](./tracing.md)。 -* GreptimeDB 的 [灾难恢复方案](./disaster-recovery/overview.md)。 +* 数据库配置，请阅读 [配置](/user-guide/deployments/configuration.md) 参考。 +* GreptimeDB 的 [监控](/user-guide/operations/monitoring.md) 和 [链路追踪](/user-guide/operations/tracing.md)。 +* GreptimeDB 的 [灾难恢复方案](/user-guide/operations/disaster-recovery/overview.md)。 ### 运行时信息 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/capacity-plan.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/capacity-plan.md index d07534509..2bd9d1286 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/capacity-plan.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/capacity-plan.md @@ -13,7 +13,7 @@ GreptimeDB 具备超轻量级的启动基准， - 数据保留策略 - 硬件成本 -要监控 GreptimeDB 的各种指标，请参阅[监控](./monitoring.md)。 +要监控 GreptimeDB 的各种指标，请参阅[监控](/user-guide/operations/monitoring.md)。 ## CPU @@ -41,7 +41,7 @@ GreptimeDB 具有高效的数据压缩机制，可将原始数据大小减少到 数据可以存储在本地文件系统或云存储中，例如 AWS S3。 有关存储选项的更多信息， -请参阅[存储配置](./configuration.md#存储选项)文档。 +请参阅[存储配置](/user-guide/deployments/configuration.md#存储选项)文档。 由于云存储在存储管理方面的简单性，强烈推荐使用云存储进行数据存储。 使用云存储时，本地存储空间只需要大约 200GB 用于查询相关的缓存和 Write-Ahead Log (WAL)。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/monitoring.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/monitoring.md index 460f9655e..f65b1f168 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/monitoring.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/monitoring.md @@ -43,7 +43,7 @@ docker run \ ## 将指标保存到 GreptimeDB 自身 你还可以将指标保存到 GreptimeDB 本身，以便于使用 SQL 语句进行查询和分析。 -本节提供了相关配置示例，有关配置的更多详细信息，请参阅[监控指标选项](./configuration.md#monitor-metrics-options)。 +本节提供了相关配置示例，有关配置的更多详细信息，请参阅[监控指标选项](/user-guide/deployments/configuration.md#monitor-metrics-options)。 ### 单机模式 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/overview.md index c1643b7cb..2305cb643 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/overview.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/overview.md @@ -1,11 +1,8 @@ # 概述 * [管理](./admin.md) -* [配置 GreptimeDB](./configuration.md) * [容量规划](./capacity-plan.md) * [灾难恢复](./disaster-recovery/overview.md) -* [Kubernetes](./deploy-on-kubernetes/overview.md) -* [在 Android 平台运行](./run-on-android.md) * [监控](./monitoring.md) * [Tracing](./tracing.md) * [Remote WAL](./remote-wal/quick-start.md) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/region-failover.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/region-failover.md index 827fd0c4a..60ae5baaa 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/region-failover.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/region-failover.md @@ -8,12 +8,12 @@ Region Failover 提供了在不丢失数据的情况下从 Region 故障中恢 该功能仅在 GreptimeDB 集群模式下可用，并且需要满足以下条件 - 使用 Kafka WAL -- 使用[共享存储](/user-guide/operations/configuration.md#storage-options) (例如：AWS S3) +- 使用[共享存储](/user-guide/deployments/configuration.md#storage-options) (例如：AWS S3) ### 通过配置文件 -在 [metasrv](/user-guide/operations/configuration.md#metasrv-only-configuration) 配置文件中设置 `enable_region_failover=true`. +在 [metasrv](/user-guide/deployments/configuration.md#metasrv-only-configuration) 配置文件中设置 `enable_region_failover=true`. ### 通过 GreptimeDB Operator @@ -42,7 +42,7 @@ Region Failover 的恢复时间取决于： 尽管多个 Region 共享同一个 Topic，可以让 Datanode 支持更多的 Region，但这种方法的代价是在 Region 重放过程中产生读取放大。 -例如，为 [metasrv](/user-guide/operations/configuration.md#metasrv-only-configuration) 配置 128 个 Topic，如果整个集群包含 1024 个 Region（物理 Region），那么每 8 个 Region 将共享一个 Topic。 +例如，为 [metasrv](/user-guide/deployments/configuration.md#metasrv-only-configuration) 配置 128 个 Topic，如果整个集群包含 1024 个 Region（物理 Region），那么每 8 个 Region 将共享一个 Topic。 ![Read Amplification](/remote-wal-read-amplification.png) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/tracing.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/tracing.md index bde3176eb..4c151a9bc 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/tracing.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/operations/tracing.md @@ -2,7 +2,7 @@ GreptimeDB 支持分布式链路追踪。 GreptimeDB 使用基于 gRPC 的 OTLP 协议导出所有采集到的 Span。您可以使用 [Jaeger](https://www.jaegertracing.io/)、[Tempo](https://grafana.com/oss/tempo/) 等支持基于 gRPC 的 OTLP 协议后端接收 GreptimeDB 采集到的 Span。 -在配置中的 [logging 部分](./configuration.md#logging-选项) 有对 tracing 的相关配置项说明，[standalone.example.toml](https://github.com/GreptimeTeam/greptimedb/blob/main/config/standalone.example.toml) 的 logging 部分提供了参考配置项。 +在配置中的 [logging 部分](/user-guide/deployments/configuration.md#logging-选项) 有对 tracing 的相关配置项说明，[standalone.example.toml](https://github.com/GreptimeTeam/greptimedb/blob/main/config/standalone.example.toml) 的 logging 部分提供了参考配置项。 ## 教程：使用 Jaeger 追踪 GreptimeDB 调用链路 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/mysql.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/mysql.md index bceb8e34e..f4d89b1f4 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/mysql.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/mysql.md @@ -8,8 +8,8 @@ mysql -h -P 4002 -u -p ``` -- 请参考[鉴权认证](/user-guide/operations/authentication.md) 来设置 GreptimeDB 的用户名和密码。 -- 如果你想使用其他端口连接 MySQL，请参考配置文档中的[协议选项](/user-guide/operations/configuration.md#协议选项)。 +- 请参考[鉴权认证](/user-guide/deployments/authentication.md) 来设置 GreptimeDB 的用户名和密码。 +- 如果你想使用其他端口连接 MySQL，请参考配置文档中的[协议选项](/user-guide/deployments/configuration.md#协议选项)。 ## 管理表 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/postgresql.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/postgresql.md index 3aa072c68..08b403c63 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/postgresql.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/postgresql.md @@ -9,8 +9,8 @@ psql -h -p 4003 -U -d public ``` -- 请参考[鉴权认证](/user-guide/operations/authentication.md) 来设置 GreptimeDB 的用户名和密码。 -- 如果你想使用其他端口连接 PostgreSQL，请参考配置文档中的[协议选项](/user-guide/operations/configuration.md#协议选项)。 +- 请参考[鉴权认证](/user-guide/deployments/authentication.md) 来设置 GreptimeDB 的用户名和密码。 +- 如果你想使用其他端口连接 PostgreSQL，请参考配置文档中的[协议选项](/user-guide/deployments/configuration.md#协议选项)。 ## 管理表 diff --git a/sidebars.ts b/sidebars.ts index 3204b8898..43ac19a84 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -148,31 +148,38 @@ const sidebars: SidebarsConfig = { 'user-guide/table-management', { type: 'category', - label: 'Operations', + label: 'Deployments', items: [ - 'user-guide/operations/overview', - 'user-guide/operations/authentication', - 'user-guide/operations/admin', - 'user-guide/operations/configuration', - 'user-guide/operations/capacity-plan', + 'user-guide/deployments/overview', + 'user-guide/deployments/configuration', + 'user-guide/deployments/authentication', { type: 'category', label: 'Deploy on Kubernetes', items: [ - 'user-guide/operations/deploy-on-kubernetes/overview', + 'user-guide/deployments/deploy-on-kubernetes/overview', { type: 'category', label: 'Manage GreptimeDB Operator', items: [ - 'user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator', - 'user-guide/operations/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator', + 'user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator', + 'user-guide/deployments/deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator', ] }, - 'user-guide/operations/deploy-on-kubernetes/deploy-greptimedb-cluster', - 'user-guide/operations/deploy-on-kubernetes/destroy-cluster', + 'user-guide/deployments/deploy-on-kubernetes/deploy-greptimedb-cluster', + 'user-guide/deployments/deploy-on-kubernetes/destroy-cluster', ], }, - 'user-guide/operations/run-on-android', + 'user-guide/deployments/run-on-android', + ], + }, + { + type: 'category', + label: 'Operations', + items: [ + 'user-guide/operations/overview', + 'user-guide/operations/admin', + 'user-guide/operations/capacity-plan', { type: 'category', label: 'Disaster Recovery',