virtualization/openapi/doc-ru-config-values.yaml at 64578293641d3435d31f5088f997fb8e53260bf5 · deckhouse/virtualization · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
type: object
properties:
  highAvailability:
    description: |
      Ручное управление режимом отказоустойчивости.

      По умолчанию режим отказоустойчивости определяется автоматически.
      Подробнее про режим отказоустойчивости можно прочитать в разделе [Высокая надежность и доступность](/products/kubernetes-platform/documentation/v1/admin/configuration/high-reliability-and-availability/enable.html#включение-режима-ha-для-отдельных-компонентов).
  virtualMachineCIDRs:
    description: |
      Список подсетей используемых для выделения статических IP-адресов виртуальным машинам.

      > **Внимание.** Подсеть для виртуальных машин не должна совпадать с подсетями подов, сервисов и узлов. Конфликт адресов может привести к непредсказуемому поведению и сетевым проблемам.
      >
      > Запрещено удалять подсети, из которых уже были назначены IP-адреса виртуальным машинам.
  ingressClass:
    description: |
      Класс Ingress-контроллера, который использоваться для загрузки образов.
      По умолчанию используется глобальное значение `modules.ingressClass`.
  https:
    description: |
      Тип используемого сертификата.

      Этот параметр задаёт особые настройки https для модуля, переопределяя глобальные настройки `global.modules.https`.
    properties:
      mode:
        description: |
          Режим работы HTTPS:
          - `CertManager` — доступ по HTTPS с заказом сертификата согласно ClusterIssuer'у, заданному в параметре `certManager.clusterIssuerName`.
          - `CustomCertificate` — доступ по HTTPS с использованием сертификата из пространства имён `d8-system`.
          - `Disabled` — доступ только по HTTP.
          - `OnlyInURI` — доступ по HTTP, подразумевая, что перед web-интерфейсом стоит внешний HTTPS-балансер, который терминирует HTTPS и все ссылки в `user-authn` будут генерироваться с HTTPS-схемой.
      certManager:
        description: Настройки для certmanager.
        properties:
          clusterIssuerName:
            description: |
              Тип ClusterIssuer'а, используемого для заказа SSL-сертификата (в данный момент доступны `letsencrypt`, `letsencrypt-staging`, `selfsigned`, но возможно определить свои).
      customCertificate:
        description: Настройки для использования пользовательского сертификата.
        properties:
          secretName:
            description: |
              Имя Secret'а в пространстве имён `d8-system`, который будет использоваться для web-интерфейса загрузки модуля CDI.

              Secret должен быть в формате [kubernetes.io/tls](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#tls-secrets).
  dvcr:
    description: |
      Параметры, для настройки deckhouse virtualization container registry.
      Внутренний сервис для хранения и кеширования образов виртуальных машин.
    properties:
      storage:
        description: |
          Параметры для настройки хранилища.
        properties:
          type:
            description: |
              Тип используемого хранилища.
              - `persistentVolumeClaim` — Использование pvc
              - `objectStorage` — Использование objectStorage
          persistentVolumeClaim:
            description: |
              Параметры для настройки PersistentVolumeClaim.
            properties:
              storageClassName:
                description: |
                  Имя StorageClass, используемого для создания persistentvolumeclaim. Если не указан - будет использоваться StorageClass, указанный в кластере по умолчанию.
              size:
                description: |
                  Размер pvc.
          objectStorage:
            description: |
              Параметры для настройки объектного хранилища.
            properties:
              s3:
                description: |
                  Параметры для использования s3.
                properties:
                  accessKey:
                    description: |
                      accessKey должен быть закодирован в base64.
                      accessKey — это уникальный идентификатор, который идентифицирует вас как пользователя, имеющего доступ к S3.
                  secretKey:
                    description: |
                      secretKey должен быть закодирован в base64.
                      secretKey — это конфиденциальный секретный ключ, связанный с вашим идентификатором ключа доступа.
                  region:
                    description: |
                      Географическая зона.
                  regionEndpoint:
                    description: |
                      Конечная точка для подключения к сервису S3.
                  bucket:
                    description: |
                      Контейнер, в котором вы можете хранить свои файлы и объекты данных.
      gc:
        description: Настройки очистки хранилища
        properties:
          schedule:
            description: |
              Расписание для запуска процедуры очистки хранилища. Очистка удалит неактуальные образы, созданные для ресурсов `ClusterVirtualImage`, `VirtualImage`, `VirtualDisk`, которых уже нет в кластере.

              Расписание по умолчанию не задано. Периодическая очистка включится, если задать расписание.
  virtualImages:
    type: object
    description: |
      Настройка класса хранения для виртуальных образов на PVC.
    properties:
      storageClassName:
        type: string
        description: |
          Поскольку этот параметр был устаревшим, используйте параметр `defaultStorageClassName`.
      defaultStorageClassName:
        type: string
        description: |
          Указывает имя класса хранения по умолчанию, который будет использоваться для виртуальных образов на PVC.
      allowedStorageClassSelector:
        type: object
        description: |
          Селектор разрешенных классов хранения, которые можно использовать для виртуальных образов на PVC.
        minProperties: 1
        properties:
          matchNames:
            type: array
            minItems: 1
            items:
              type: string
              minLength: 1
  virtualDisks:
    type: object
    description: |
      Настройка класса хранения для виртуальных дисков.
    properties:
      defaultStorageClassName:
        type: string
        description: |
          Указывает имя класса хранения по умолчанию, который будет использоваться для виртуальных дисков.
      allowedStorageClassSelector:
        type: object
        description: |
          Селектор разрешенных классов хранения, используемых для виртуальных дисков.
        minProperties: 1
        properties:
          matchNames:
            type: array
            minItems: 1
            items:
              type: string
              minLength: 1
  audit:
    type: object
    description: |
      Настройки для контроллера аудита.
    properties:
      enabled:
        type: boolean
        default: false
        description: |
          Включение контроллера аудита.
  logLevel:
    type: string
    description: |
      Устанавливает уровень логирования.

      Работает для следующих компонентов:
      - `virtualization-api`
      - `virtualization-controller`
      - `kube-api-rewriter`
      - `vm-route-forge`
  logFormat:
    type: string
    description: |
      Устанавливает формат логирования.

      Работает для следующих компонентов:
      - `virtualization-controller`