Skip to content

Commit f6ab144

Browse files
jsenkojsenko
committed
chore(operator): update install file
1 parent 0eb541d commit f6ab144

File tree

1 file changed

+139
-49
lines changed

1 file changed

+139
-49
lines changed

‎operator/install/install.yaml

+139-49
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ spec:
2525
spec:
2626
properties:
2727
app:
28-
description: Configuration specific to Apicurio Registry backend component.
28+
description: Configure Apicurio Registry backend (app) component.
2929
properties:
3030
env:
31-
description: List of environment variables that should be passed
32-
to the App component.
31+
description: Configure a list of environment variables that will
32+
be passed to this components' container.
3333
items:
3434
properties:
3535
name:
@@ -79,27 +79,37 @@ spec:
7979
type: object
8080
type: array
8181
host:
82-
description: |-
83-
Apicurio Registry backend component hostname.
84-
If the value is empty, the Operator will not create an Ingress resource for the component.
85-
IMPORTANT: If the Ingress already exists and the value becomes empty, the Ingress will be deleted.
86-
87-
Note that the UI component requires a browser-accessible URL to the Apicurio Registry backend to work properly.
88-
If you create the Ingress manually, you have to manually set the REGISTRY_API_URL environment variable for the backend component.
82+
description: 'DEPRECATED: Use the `(component).ingress.host` field
83+
instead. The operator will attempt to update the field automatically.'
8984
type: string
85+
ingress:
86+
description: Configure Ingress for the component.
87+
properties:
88+
host:
89+
description: |-
90+
Configure hostname of the operator-managed Ingress. If the value is empty, the operator will not create an Ingress resource for the component.
91+
92+
IMPORTANT: If the Ingress already exists and the value becomes empty, the Ingress will be deleted.
93+
type: string
94+
type: object
9095
kafkasql:
91-
description: Configure KafkaSQL storage.
96+
description: |-
97+
DEPRECATED: Use the `app.storage.type` and `app.storage.kafkasql` fields instead.
98+
The operator will attempt to update the fields automatically.
9299
properties:
93100
bootstrapServers:
94-
description: Configure Kafka bootstrap servers.
101+
description: 'DEPRECATED: Use the `app.storage.kafkasql.bootstrapServers`
102+
field instead. The operator will attempt to update the field
103+
automatically.'
95104
type: string
96105
type: object
97106
podTemplateSpec:
98-
description: |
99-
This field can be used to specify a PodTemplateSpec that will be used to generate Deployment for the App component
100-
This allows users to modify the apicurio-registry-app container, or adding another container to the pod.
101-
Operator will apply changes on top of this PTS, so some parts might be overridden, depending on other fields in this CR.
102-
Restrictions: `.spec.containers[name = apicurio-registry-app].env` must be empty.
107+
description: |-
108+
`PodTemplateSpec` describes the data a pod should have when created from a template.
109+
110+
This template is used by the operator to create the components' Deployment. The operator first extends the template
111+
with default values if required, and then applies additional configuration
112+
based on the other contents of `ApicurioRegistry3` CR.
103113
properties:
104114
metadata:
105115
properties:
@@ -3010,34 +3020,96 @@ spec:
30103020
type: object
30113021
type: object
30123022
sql:
3013-
description: Configuration of Apicurio Registry SQL storage.
3023+
description: |-
3024+
DEPRECATED: Use the `app.storage.type` and `app.storage.sql` fields instead.
3025+
The operator will attempt to update the fields automatically.
30143026
properties:
30153027
dataSource:
3016-
description: SQL data source.
3028+
description: 'DEPRECATED: Use the `app.storage.sql.dataSource`
3029+
field instead. The operator will attempt to update the field
3030+
automatically.'
30173031
properties:
30183032
password:
3019-
description: Data source password.
3033+
description: 'DEPRECATED: Use the `app.storage.sql.dataSource.password`
3034+
field instead. The operator will attempt to update the
3035+
field automatically.'
30203036
type: string
30213037
url:
3022-
description: |-
3023-
Data source URL: \n URL of the PostgreSQL
3024-
database, for example: `jdbc:postgresql://<service name>.<namespace>.svc:5432/<database name>`.
3038+
description: 'DEPRECATED: Use the `app.storage.sql.dataSource.url`
3039+
field instead. The operator will attempt to update the
3040+
field automatically.'
30253041
type: string
30263042
username:
3027-
description: Data source username.
3043+
description: 'DEPRECATED: Use the `app.storage.sql.dataSource.username`
3044+
field instead. The operator will attempt to update the
3045+
field automatically.'
30283046
type: string
30293047
type: object
30303048
type: object
3049+
storage:
3050+
description: |
3051+
Configure storage for Apicurio Registry backend (app).
3052+
properties:
3053+
kafkasql:
3054+
description: Configure KafkaSQL storage type.
3055+
properties:
3056+
bootstrapServers:
3057+
description: |-
3058+
Configure Kafka bootstrap servers.
3059+
3060+
Required if `app.storage.type` is `kafkasql`.
3061+
type: string
3062+
type: object
3063+
sql:
3064+
description: Configure SQL storage types.
3065+
properties:
3066+
dataSource:
3067+
description: Configure SQL data source.
3068+
properties:
3069+
password:
3070+
description: |-
3071+
Configure SQL data source password.
3072+
3073+
If you want to reference a Secret, you can set the `APICURIO_DATASOURCE_PASSWORD` environment variable directly using the `app.env` field.
3074+
type: string
3075+
url:
3076+
description: |-
3077+
Configure SQL data source URL.
3078+
3079+
Example: `jdbc:postgresql://example-postgresql-database:5432/apicurio`.
3080+
type: string
3081+
username:
3082+
description: Configure SQL data source username.
3083+
type: string
3084+
type: object
3085+
type: object
3086+
type:
3087+
description: |-
3088+
Configure type of storage that Apicurio Registry backend (app) will use:
3089+
3090+
* <empty> - in-memory storage.
3091+
* `postgresql` - Postgresql storage type, must be further configured using the `app.storage.sql` field.
3092+
* `kafkasql` - KafkaSQL storage type, must be further configured using the `app.storage.kafkasql` field.
3093+
3094+
IMPORTANT: Defaults to the in-memory storage, which is not suitable for production.
3095+
enum:
3096+
- kafkasql
3097+
- postgresql
3098+
type: string
3099+
type: object
30313100
type: object
30323101
studioUi:
3033-
description: Configuration specific to Apicurio Studio UI component.
3102+
description: Configure Apicurio Studio UI component.
30343103
properties:
30353104
enabled:
3036-
description: Enable the deployment of the Studio UI component.
3105+
description: |
3106+
Enable deployment of the Apicurio Studio UI component.
3107+
3108+
Defaults to `false`.
30373109
type: boolean
30383110
env:
3039-
description: List of environment variables that should be passed
3040-
to the Studio UI component.
3111+
description: Configure a list of environment variables that will
3112+
be passed to this components' container.
30413113
items:
30423114
properties:
30433115
name:
@@ -3087,17 +3159,26 @@ spec:
30873159
type: object
30883160
type: array
30893161
host:
3090-
description: |-
3091-
Apicurio Studio UI component hostname.
3092-
If the value is empty, the Operator will not create an Ingress resource for the component.
3093-
IMPORTANT: If the Ingress already exists and the value becomes empty, the Ingress will be deleted.
3162+
description: 'DEPRECATED: Use the `(component).ingress.host` field
3163+
instead. The operator will attempt to update the field automatically.'
30943164
type: string
3165+
ingress:
3166+
description: Configure Ingress for the component.
3167+
properties:
3168+
host:
3169+
description: |-
3170+
Configure hostname of the operator-managed Ingress. If the value is empty, the operator will not create an Ingress resource for the component.
3171+
3172+
IMPORTANT: If the Ingress already exists and the value becomes empty, the Ingress will be deleted.
3173+
type: string
3174+
type: object
30953175
podTemplateSpec:
30963176
description: |-
3097-
This field can be used to specify a PodTemplateSpec that will be used to generate Deployment for the UI component.
3098-
This allows users to modify the apicurio-studio-ui container, or adding another container to the pod.
3099-
Operator will apply changes on top of this PTS, so some parts might be overridden, depending on other fields in this CR.
3100-
Restrictions: `.spec.containers[name = apicurio-studio-ui].env` must be empty.
3177+
`PodTemplateSpec` describes the data a pod should have when created from a template.
3178+
3179+
This template is used by the operator to create the components' Deployment. The operator first extends the template
3180+
with default values if required, and then applies additional configuration
3181+
based on the other contents of `ApicurioRegistry3` CR.
31013182
properties:
31023183
metadata:
31033184
properties:
@@ -6009,11 +6090,12 @@ spec:
60096090
type: object
60106091
type: object
60116092
ui:
6012-
description: Configuration specific to Apicurio Registry UI component.
6093+
description: |
6094+
Configure Apicurio Registry UI component.
60136095
properties:
60146096
env:
6015-
description: List of environment variables that should be passed
6016-
to the UI component.
6097+
description: Configure a list of environment variables that will
6098+
be passed to this components' container.
60176099
items:
60186100
properties:
60196101
name:
@@ -6063,17 +6145,26 @@ spec:
60636145
type: object
60646146
type: array
60656147
host:
6066-
description: |-
6067-
Apicurio Registry UI component hostname.
6068-
If the value is empty, the Operator will not create an Ingress resource for the component.
6069-
IMPORTANT: If the Ingress already exists and the value becomes empty, the Ingress will be deleted.
6148+
description: 'DEPRECATED: Use the `(component).ingress.host` field
6149+
instead. The operator will attempt to update the field automatically.'
60706150
type: string
6151+
ingress:
6152+
description: Configure Ingress for the component.
6153+
properties:
6154+
host:
6155+
description: |-
6156+
Configure hostname of the operator-managed Ingress. If the value is empty, the operator will not create an Ingress resource for the component.
6157+
6158+
IMPORTANT: If the Ingress already exists and the value becomes empty, the Ingress will be deleted.
6159+
type: string
6160+
type: object
60716161
podTemplateSpec:
60726162
description: |-
6073-
This field can be used to specify a PodTemplateSpec that will be used to generate Deployment for the UI component.
6074-
This allows users to modify the apicurio-registry-ui container, or adding another container to the pod.
6075-
Operator will apply changes on top of this PTS, so some parts might be overridden, depending on other fields in this CR.
6076-
Restrictions: `.spec.containers[name = apicurio-registry-ui].env` must be empty.
6163+
`PodTemplateSpec` describes the data a pod should have when created from a template.
6164+
6165+
This template is used by the operator to create the components' Deployment. The operator first extends the template
6166+
with default values if required, and then applies additional configuration
6167+
based on the other contents of `ApicurioRegistry3` CR.
60776168
properties:
60786169
metadata:
60796170
properties:
@@ -8988,8 +9079,7 @@ spec:
89889079
status:
89899080
properties:
89909081
conditions:
8991-
description: "Conditions: \n Apicurio Registry application and Operator
8992-
conditions."
9082+
description: Apicurio Registry operator and operand conditions.
89939083
items:
89949084
properties:
89959085
lastTransitionTime:

0 commit comments

Comments
 (0)