Skip to content

Commit b5b10f6

Browse files
authored
fixing the ydbops config.yaml reference (#15561)
1 parent a04691a commit b5b10f6

File tree

2 files changed

+44
-36
lines changed

2 files changed

+44
-36
lines changed

ydb/docs/en/core/reference/ydbops/configuration.md

+22-18
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,14 @@ For the invocation above, the following `config.yaml` is assumed to be present:
4444

4545
```yaml
4646
current-profile: my-profile
47-
my-profile:
48-
endpoint: grpc://<hostname>:2135
49-
user: admin
50-
password-file: ~/<password-file>
51-
k8s-namespace: <k8s-namespace>
52-
kubeconfig: ~/.kube/config
47+
profiles:
48+
my-profile:
49+
endpoint: grpcs://<hostname>:2135
50+
ca-file: ~/<ca-certificate-file>
51+
user: <username>
52+
password-file: ~/<password-file>
53+
k8s-namespace: <k8s-namespace>
54+
kubeconfig: ~/.kube/config
5355
```
5456
5557
### Profile management commands
@@ -67,22 +69,24 @@ Here is an example of a configuration file with all possible options that can be
6769
# be used as the default active profile in the CLI invocation
6870
current-profile: my-profile
6971

70-
my-profile:
71-
endpoint: grpc://your.ydb.cluster.fqdn:2135
72+
# profile definitions are added as subkeys to the `profiles` key
73+
profiles:
74+
my-profile:
75+
endpoint: grpcs://your.ydb.cluster.fqdn:2135
7276

73-
# CA file location if using grpcs to the endpoint
74-
ca-file: /path/to/custom/ca/file
77+
# CA file location if using grpcs to the endpoint
78+
ca-file: /path/to/custom/ca/file
7579

76-
# a username and password file if static credentials are used:
77-
user: your-ydb-user-name
78-
password-file: /path/to/password-file
80+
# a username and password file if static credentials are used:
81+
user: your-ydb-user-name
82+
password-file: /path/to/password-file
7983

80-
# when using access token
81-
token-file: /path/to/ydb/token
84+
# when using access token
85+
token-file: /path/to/ydb/token
8286

83-
# if working with YDB clusters in Kubernetes, kubeconfig path can be specified:
84-
kubeconfig: /path/to/kube/config
85-
k8s-namespace: <k8s-namespace>
87+
# if working with YDB clusters in Kubernetes, kubeconfig path can be specified:
88+
kubeconfig: /path/to/kube/config
89+
k8s-namespace: <k8s-namespace>
8690
```
8791
8892
## Environment variables {#environment-variables}

ydb/docs/ru/core/reference/ydbops/configuration.md

+22-18
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,14 @@ ydbops restart \
4646

4747
```yaml
4848
current-profile: my-profile
49-
my-profile:
50-
endpoint: grpc://<hostname>:2135
51-
user: admin
52-
password-file: ~/<password-file>
53-
k8s-namespace: <k8s-namespace>
54-
kubeconfig: ~/.kube/config
49+
profiles:
50+
my-profile:
51+
endpoint: grpcs://<hostname>:2135
52+
ca-file: ~/<ca-certificate-file>
53+
user: <username>
54+
password-file: ~/<password-file>
55+
k8s-namespace: <k8s-namespace>
56+
kubeconfig: ~/.kube/config
5557
```
5658
5759
### Команды управления профилями
@@ -69,22 +71,24 @@ my-profile:
6971
# использования в качестве активного профиля по умолчанию при вызове CLI
7072
current-profile: my-profile
7173

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

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

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

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

85-
# если идет работа с YDB кластерами под Kubernetes, можно указать путь к kubeconfig:
86-
kubeconfig: /path/to/kube/config
87-
k8s-namespace: <k8s-namespace>
89+
# если идет работа с YDB кластерами под Kubernetes, можно указать путь к kubeconfig:
90+
kubeconfig: /path/to/kube/config
91+
k8s-namespace: <k8s-namespace>
8892
```
8993
9094
## Переменные окружения {#environment-variables}

0 commit comments

Comments
 (0)