Skip to content

Commit 5efebfe

Browse files
camilamacedo86perdasilva
authored andcommitted
doc: fix layout of the doc (#171)
Signed-off-by: Per G. da Silva <[email protected]>
1 parent 0a26140 commit 5efebfe

File tree

5 files changed

+65
-52
lines changed

5 files changed

+65
-52
lines changed

Diff for: crds/operators.coreos.com_catalogsources.yaml

+13-10
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,26 @@ spec:
5959
address:
6060
description: 'Address is a host that OLM can use to connect to a pre-existing registry. Format: <registry-host or ip>:<port> Only used when SourceType = SourceTypeGrpc. Ignored when the Image field is set.'
6161
type: string
62-
config:
63-
description: Config adds additional optional settings, e.g. catalog source pod node selectors and tolerations
62+
configMap:
63+
description: ConfigMap is the name of the ConfigMap to be used to back a configmap-server registry. Only used when SourceType = SourceTypeConfigmap or SourceTypeInternal.
64+
type: string
65+
description:
66+
type: string
67+
displayName:
68+
description: Metadata
69+
type: string
70+
grpcPodConfig:
71+
description: GrpcPodConfig exposes different overrides for the pod spec of the CatalogSource Pod. Only used when SourceType = SourceTypeGrpc and Image is set.
6472
type: object
6573
properties:
6674
nodeSelector:
6775
description: 'NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node''s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/'
6876
type: object
6977
additionalProperties:
7078
type: string
79+
priorityClassName:
80+
description: If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
81+
type: string
7182
tolerations:
7283
description: Tolerations are the catalog source's pod's tolerations.
7384
type: array
@@ -91,14 +102,6 @@ spec:
91102
value:
92103
description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
93104
type: string
94-
configMap:
95-
description: ConfigMap is the name of the ConfigMap to be used to back a configmap-server registry. Only used when SourceType = SourceTypeConfigmap or SourceTypeInternal.
96-
type: string
97-
description:
98-
type: string
99-
displayName:
100-
description: Metadata
101-
type: string
102105
icon:
103106
type: object
104107
required:

Diff for: crds/zz_defs.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: pkg/operators/v1alpha1/catalogsource_types.go

+14-4
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,10 @@ type CatalogSourceSpec struct {
8080
// +Optional
8181
Secrets []string `json:"secrets,omitempty"`
8282

83-
// Config adds additional optional settings, e.g. catalog source pod node selectors and tolerations
83+
// GrpcPodConfig exposes different overrides for the pod spec of the CatalogSource Pod.
84+
// Only used when SourceType = SourceTypeGrpc and Image is set.
8485
// +Optional
85-
Config *CatalogSourceConfig `json:"config,omitempty"`
86+
GrpcPodConfig *GrpcPodConfig `json:"grpcPodConfig,omitempty"`
8687

8788
// Metadata
8889
DisplayName string `json:"displayName,omitempty"`
@@ -91,8 +92,8 @@ type CatalogSourceSpec struct {
9192
Icon Icon `json:"icon,omitempty"`
9293
}
9394

94-
// CatalogSourceConfig contains configuration specified for a catalog source
95-
type CatalogSourceConfig struct {
95+
// GrpcPodConfig contains configuration specified for a catalog source
96+
type GrpcPodConfig struct {
9697
// NodeSelector is a selector which must be true for the pod to fit on a node.
9798
// Selector which must match a node's labels for the pod to be scheduled on that node.
9899
// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
@@ -102,6 +103,15 @@ type CatalogSourceConfig struct {
102103
// Tolerations are the catalog source's pod's tolerations.
103104
// +optional
104105
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
106+
107+
// If specified, indicates the pod's priority. "system-node-critical" and
108+
// "system-cluster-critical" are two special keywords which indicate the
109+
// highest priorities with the former being the highest priority. Any other
110+
// name must be defined by creating a PriorityClass object with that name.
111+
// If not specified, the pod priority will be default or zero if there is no
112+
// default.
113+
// +optional
114+
PriorityClassName string `json:"priorityClassName,omitempty" protobuf:"bytes,24,opt,name=priorityClassName"`
105115
}
106116

107117
// UpdateStrategy holds all the different types of catalog source update strategies

Diff for: pkg/operators/v1alpha1/zz_generated.deepcopy.go

+32-32
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: pkg/validation/internal/bundle.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ func validateServiceAccounts(bundle *manifests.Bundle) []errors.Error {
5252
sa := v1.ServiceAccount{}
5353
if err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.Object, &sa); err == nil {
5454
if _, ok := saNamesFromCSV[sa.Name]; ok {
55-
errs = append(errs, errors.ErrInvalidBundle(fmt.Sprintf("invalid service account found in bundle. " +
56-
"This service account %s in your bundle is not valid, because a service account with the same name " +
57-
"was already specified in your CSV. If this was unintentional, please remove the service account " +
58-
"manifest from your bundle. If it was intentional to specify a separate service account, " +
59-
"please rename the SA in either the bundle manifest or the CSV.",sa.Name), sa.Name))
55+
errs = append(errs, errors.ErrInvalidBundle(fmt.Sprintf("invalid service account found in bundle. "+
56+
"This service account %s in your bundle is not valid, because a service account with the same name "+
57+
"was already specified in your CSV. If this was unintentional, please remove the service account "+
58+
"manifest from your bundle. If it was intentional to specify a separate service account, "+
59+
"please rename the SA in either the bundle manifest or the CSV.", sa.Name), sa.Name))
6060
}
6161
}
6262
}

0 commit comments

Comments
 (0)