Skip to content

fixing the ydbops config.yaml reference #15561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2025
Merged

fixing the ydbops config.yaml reference #15561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions ydb/docs/en/core/reference/ydbops/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,14 @@ For the invocation above, the following `config.yaml` is assumed to be present:

```yaml
current-profile: my-profile
my-profile:
endpoint: grpc://<hostname>:2135
user: admin
password-file: ~/<password-file>
k8s-namespace: <k8s-namespace>
kubeconfig: ~/.kube/config
profiles:
my-profile:
endpoint: grpcs://<hostname>:2135
ca-file: ~/<ca-certificate-file>
user: <username>
password-file: ~/<password-file>
k8s-namespace: <k8s-namespace>
kubeconfig: ~/.kube/config
```

### Profile management commands
Expand All @@ -67,22 +69,24 @@ Here is an example of a configuration file with all possible options that can be
# be used as the default active profile in the CLI invocation
current-profile: my-profile

my-profile:
endpoint: grpc://your.ydb.cluster.fqdn:2135
# profile definitions are added as subkeys to the `profiles` key
profiles:
my-profile:
endpoint: grpcs://your.ydb.cluster.fqdn:2135

# CA file location if using grpcs to the endpoint
ca-file: /path/to/custom/ca/file
# CA file location if using grpcs to the endpoint
ca-file: /path/to/custom/ca/file

# a username and password file if static credentials are used:
user: your-ydb-user-name
password-file: /path/to/password-file
# a username and password file if static credentials are used:
user: your-ydb-user-name
password-file: /path/to/password-file

# when using access token
token-file: /path/to/ydb/token
# when using access token
token-file: /path/to/ydb/token

# if working with YDB clusters in Kubernetes, kubeconfig path can be specified:
kubeconfig: /path/to/kube/config
k8s-namespace: <k8s-namespace>
# if working with YDB clusters in Kubernetes, kubeconfig path can be specified:
kubeconfig: /path/to/kube/config
k8s-namespace: <k8s-namespace>
```

## Environment variables {#environment-variables}
Expand Down
40 changes: 22 additions & 18 deletions ydb/docs/ru/core/reference/ydbops/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,14 @@ ydbops restart \

```yaml
current-profile: my-profile
my-profile:
endpoint: grpc://<hostname>:2135
user: admin
password-file: ~/<password-file>
k8s-namespace: <k8s-namespace>
kubeconfig: ~/.kube/config
profiles:
my-profile:
endpoint: grpcs://<hostname>:2135
ca-file: ~/<ca-certificate-file>
user: <username>
password-file: ~/<password-file>
k8s-namespace: <k8s-namespace>
kubeconfig: ~/.kube/config
```

### Команды управления профилями
Expand All @@ -69,22 +71,24 @@ my-profile:
# использования в качестве активного профиля по умолчанию при вызове CLI
current-profile: my-profile

my-profile:
endpoint: grpc://your.ydb.cluster.fqdn:2135
# Описание профилей помещается в ключ `profiles`
profiles:
my-profile:
endpoint: grpcs://your.ydb.cluster.fqdn:2135

# расположение файла CA при использовании grpcs в endpoint
ca-file: /path/to/custom/ca/file
# расположение файла CA при использовании grpcs в endpoint
ca-file: /path/to/custom/ca/file

# имя пользователя и файл пароля, если используется аутентификация при помощи логина и пароля:
user: your-ydb-user-name
password-file: /path/to/password-file
# имя пользователя и файл пароля, если используется аутентификация при помощи логина и пароля:
user: your-ydb-user-name
password-file: /path/to/password-file

# если используется аутентификация при помощи access token
token-file: /path/to/ydb/token
# если используется аутентификация при помощи access token
token-file: /path/to/ydb/token

# если идет работа с YDB кластерами под Kubernetes, можно указать путь к kubeconfig:
kubeconfig: /path/to/kube/config
k8s-namespace: <k8s-namespace>
# если идет работа с YDB кластерами под Kubernetes, можно указать путь к kubeconfig:
kubeconfig: /path/to/kube/config
k8s-namespace: <k8s-namespace>
```

## Переменные окружения {#environment-variables}
Expand Down
Loading