Skip to content

🌱 Update godoc of APIs to follow jsonField pattern #395

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
openshift-merge-bot merged 1 commit into from
Sep 11, 2025
Merged

🌱 Update godoc of APIs to follow jsonField pattern #395

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
16 changes: 8 additions & 8 deletions addon/v1alpha1/0000_00_addon.open-cluster-management.io_clustermanagementaddons.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ spec:
The rollout strategy only watches the addon configurations defined in ClusterManagementAddOn.
properties:
all:
description: All defines required fields for RolloutStrategy
description: all defines required fields for RolloutStrategy
type All
properties:
maxFailures:
Expand Down Expand Up @@ -195,7 +195,7 @@ spec:
type: string
type: object
progressive:
description: Progressive defines required fields for
description: progressive defines required fields for
RolloutStrategy type Progressive
properties:
mandatoryDecisionGroups:
Expand All @@ -211,13 +211,13 @@ spec:
properties:
groupIndex:
description: |-
GroupIndex of the decision group should match the placementDecisions label value with label key
groupIndex of the decision group should match the placementDecisions label value with label key
cluster.open-cluster-management.io/decision-group-index
format: int32
type: integer
groupName:
description: |-
GroupName of the decision group should match the placementDecisions label value with label key
groupName of the decision group should match the placementDecisions label value with label key
cluster.open-cluster-management.io/decision-group-name
type: string
type: object
Expand All @@ -227,7 +227,7 @@ spec:
- type: integer
- type: string
description: |-
MaxConcurrency is the max number of clusters to deploy workload concurrently. The default value
maxConcurrency is the max number of clusters to deploy workload concurrently. The default value
for MaxConcurrency is determined from the clustersPerDecisionGroup defined in the
placement->DecisionStrategy.
pattern: ^((100|[0-9]{1,2})%|[0-9]+)$
Expand Down Expand Up @@ -276,7 +276,7 @@ spec:
type: string
type: object
progressivePerGroup:
description: ProgressivePerGroup defines required fields
description: progressivePerGroup defines required fields
for RolloutStrategy type ProgressivePerGroup
properties:
mandatoryDecisionGroups:
Expand All @@ -292,13 +292,13 @@ spec:
properties:
groupIndex:
description: |-
GroupIndex of the decision group should match the placementDecisions label value with label key
groupIndex of the decision group should match the placementDecisions label value with label key
cluster.open-cluster-management.io/decision-group-index
format: int32
type: integer
groupName:
description: |-
GroupName of the decision group should match the placementDecisions label value with label key
groupName of the decision group should match the placementDecisions label value with label key
cluster.open-cluster-management.io/decision-group-name
type: string
type: object
Expand Down
6 changes: 3 additions & 3 deletions addon/v1alpha1/0000_02_addon.open-cluster-management.io_addondeploymentconfigs.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ spec:
type: string
customizedVariables:
description: |-
CustomizedVariables is a list of name-value variables for the current add-on deployment.
customizedVariables is a list of name-value variables for the current add-on deployment.
The add-on implementation can use these variables to render its add-on deployment.
The default is an empty list.
items:
Expand All @@ -73,7 +73,7 @@ spec:
x-kubernetes-list-type: map
nodePlacement:
description: |-
NodePlacement enables explicit control over the scheduling of the add-on agents on the
nodePlacement enables explicit control over the scheduling of the add-on agents on the
managed cluster.
All add-on agent pods are expected to comply with this node placement.
If the placement is nil, the placement is not specified, it will be omitted.
Expand Down Expand Up @@ -156,7 +156,7 @@ spec:
type: object
registries:
description: |-
Registries describes how to override images used by the addon agent on the managed cluster.
registries describes how to override images used by the addon agent on the managed cluster.
the following example will override image "quay.io/open-cluster-management/addon-agent" to
"quay.io/ocm/addon-agent" when deploying the addon agent

Expand Down
14 changes: 7 additions & 7 deletions addon/v1alpha1/0000_03_addon.open-cluster-management.io_addontemplates.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ spec:
addon agent resources yaml description.
properties:
addonName:
description: AddonName represents the name of the addon which the
description: addonName represents the name of the addon which the
template belongs to
type: string
agentSpec:
description: AgentSpec describes what/how the kubernetes resources
description: agentSpec describes what/how the kubernetes resources
of the addon agent to be deployed on a managed cluster.
properties:
deleteOption:
description: |-
DeleteOption represents deletion strategy when the manifestwork is deleted.
deleteOption represents deletion strategy when the manifestwork is deleted.
Foreground deletion strategy is applied to all the resource in this manifestwork if it is not set.
properties:
propagationPolicy:
Expand Down Expand Up @@ -171,7 +171,7 @@ spec:
type: object
type: object
manifestConfigs:
description: ManifestConfigs represents the configurations of
description: manifestConfigs represents the configurations of
manifests defined in workload field.
items:
description: ManifestConfigOption represents the configurations
Expand Down Expand Up @@ -388,11 +388,11 @@ spec:
type: object
type: array
workload:
description: Workload represents the manifest workload to be deployed
description: workload represents the manifest workload to be deployed
on a managed cluster.
properties:
manifests:
description: Manifests represents a list of kuberenetes resources
description: manifests represents a list of kubernetes resources
to be deployed on a managed cluster.
items:
description: Manifest represents a resource to be deployed
Expand All @@ -404,7 +404,7 @@ spec:
type: object
type: object
registration:
description: Registration holds the registration configuration for
description: registration holds the registration configuration for
the addon
items:
description: |-
Expand Down
6 changes: 3 additions & 3 deletions addon/v1alpha1/types_addondeploymentconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,23 @@ type AddOnDeploymentConfig struct {
}

type AddOnDeploymentConfigSpec struct {
// CustomizedVariables is a list of name-value variables for the current add-on deployment.
// customizedVariables is a list of name-value variables for the current add-on deployment.
// The add-on implementation can use these variables to render its add-on deployment.
// The default is an empty list.
// +optional
// +listType=map
// +listMapKey=name
CustomizedVariables []CustomizedVariable `json:"customizedVariables,omitempty"`

// NodePlacement enables explicit control over the scheduling of the add-on agents on the
// nodePlacement enables explicit control over the scheduling of the add-on agents on the
// managed cluster.
// All add-on agent pods are expected to comply with this node placement.
// If the placement is nil, the placement is not specified, it will be omitted.
// If the placement is an empty object, the placement will match all nodes and tolerate nothing.
// +optional
NodePlacement *NodePlacement `json:"nodePlacement,omitempty"`

// Registries describes how to override images used by the addon agent on the managed cluster.
// registries describes how to override images used by the addon agent on the managed cluster.
// the following example will override image "quay.io/open-cluster-management/addon-agent" to
// "quay.io/ocm/addon-agent" when deploying the addon agent
//
Expand Down
6 changes: 3 additions & 3 deletions addon/v1alpha1/types_addontemplate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@ type AddOnTemplate struct {

// AddOnTemplateSpec defines the template of an addon agent which will be deployed on managed clusters.
type AddOnTemplateSpec struct {
// AddonName represents the name of the addon which the template belongs to
// addonName represents the name of the addon which the template belongs to
// +kubebuilder:validation:Required
// +required
AddonName string `json:"addonName"`

// AgentSpec describes what/how the kubernetes resources of the addon agent to be deployed on a managed cluster.
// agentSpec describes what/how the kubernetes resources of the addon agent to be deployed on a managed cluster.
// +kubebuilder:validation:Required
// +required
AgentSpec work.ManifestWorkSpec `json:"agentSpec"`

// Registration holds the registration configuration for the addon
// registration holds the registration configuration for the addon
// +optional
Registration []RegistrationSpec `json:"registration"`
}
Expand Down
18 changes: 9 additions & 9 deletions cluster/v1/0000_00_clusters.open-cluster-management.io_managedclusters.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ spec:
leaseDurationSeconds:
default: 60
description: |-
LeaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
leaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
If its value is zero, the Klusterlet agent will update its lease every 60 seconds by default
format: int32
type: integer
Expand Down Expand Up @@ -114,7 +114,7 @@ spec:
type: array
taints:
description: |-
Taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
Taints, including 'ManagedClusterUnavailable' and 'ManagedClusterUnreachable', can not be added/removed by agent
running on the managed cluster; while it's fine to add/remove other taints from either hub cluser or managed cluster.
items:
Expand All @@ -124,7 +124,7 @@ spec:
properties:
effect:
description: |-
Effect indicates the effect of the taint on placements that do not tolerate the taint.
effect indicates the effect of the taint on placements that do not tolerate the taint.
Valid effects are NoSelect, PreferNoSelect and NoSelectIfNew.
enum:
- NoSelect
Expand All @@ -133,19 +133,19 @@ spec:
type: string
key:
description: |-
Key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
timeAdded:
description: TimeAdded represents the time at which the taint
description: timeAdded represents the time at which the taint
was added.
format: date-time
nullable: true
type: string
value:
description: Value is the taint value corresponding to the taint
description: value is the taint value corresponding to the taint
key.
maxLength: 1024
type: string
Expand Down Expand Up @@ -192,13 +192,13 @@ spec:
properties:
name:
description: |-
Name is the name of a ClusterClaim resource on managed cluster. It's a well known
name is the name of a ClusterClaim resource on managed cluster. It's a well known
or customized name to identify the claim.
maxLength: 253
minLength: 1
type: string
value:
description: Value is a claim-dependent string
description: value is a claim-dependent string
maxLength: 1024
minLength: 1
type: string
Expand Down Expand Up @@ -349,7 +349,7 @@ spec:
cluster.
properties:
kubernetes:
description: Kubernetes is the kubernetes version of managed cluster.
description: kubernetes is the kubernetes version of managed cluster.
type: string
type: object
type: object
Expand Down
18 changes: 9 additions & 9 deletions cluster/v1/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ type ManagedClusterSpec struct {
// +optional
HubAcceptsClient bool `json:"hubAcceptsClient"`

// LeaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
// leaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
// If its value is zero, the Klusterlet agent will update its lease every 60 seconds by default
// +optional
// +kubebuilder:default=60
LeaseDurationSeconds int32 `json:"leaseDurationSeconds,omitempty"`

// Taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
// taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
// Taints, including 'ManagedClusterUnavailable' and 'ManagedClusterUnreachable', can not be added/removed by agent
// running on the managed cluster; while it's fine to add/remove other taints from either hub cluser or managed cluster.
// +optional
Expand All @@ -92,24 +92,24 @@ type ClientConfig struct {
// The managed cluster this Taint is attached to has the "effect" on
// any placement that does not tolerate the Taint.
type Taint struct {
// Key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
// key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
// +kubebuilder:validation:Required
// +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
// +kubebuilder:validation:MaxLength=316
// +required
Key string `json:"key"`
// Value is the taint value corresponding to the taint key.
// value is the taint value corresponding to the taint key.
// +kubebuilder:validation:MaxLength=1024
// +optional
Value string `json:"value,omitempty"`
// Effect indicates the effect of the taint on placements that do not tolerate the taint.
// effect indicates the effect of the taint on placements that do not tolerate the taint.
// Valid effects are NoSelect, PreferNoSelect and NoSelectIfNew.
// +kubebuilder:validation:Required
// +kubebuilder:validation:Enum:=NoSelect;PreferNoSelect;NoSelectIfNew
// +required
Effect TaintEffect `json:"effect"`
// TimeAdded represents the time at which the taint was added.
// timeAdded represents the time at which the taint was added.
// +nullable
// +optional
TimeAdded metav1.Time `json:"timeAdded"`
Expand Down Expand Up @@ -177,20 +177,20 @@ type ManagedClusterStatus struct {
// ManagedClusterVersion represents version information about the managed cluster.
// TODO add managed agent versions
type ManagedClusterVersion struct {
// Kubernetes is the kubernetes version of managed cluster.
// kubernetes is the kubernetes version of managed cluster.
// +optional
Kubernetes string `json:"kubernetes,omitempty"`
}

// ManagedClusterClaim represents a ClusterClaim collected from a managed cluster.
type ManagedClusterClaim struct {
// Name is the name of a ClusterClaim resource on managed cluster. It's a well known
// name is the name of a ClusterClaim resource on managed cluster. It's a well known
// or customized name to identify the claim.
// +kubebuilder:validation:MaxLength=253
// +kubebuilder:validation:MinLength=1
Name string `json:"name,omitempty"`

// Value is a claim-dependent string
// value is a claim-dependent string
// +kubebuilder:validation:MaxLength=1024
// +kubebuilder:validation:MinLength=1
Value string `json:"value,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion cluster/v1alpha1/0000_02_clusters.open-cluster-management.io_clusterclaims.crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ spec:
description: Spec defines the attributes of the ClusterClaim.
properties:
value:
description: Value is a claim-dependent string
description: value is a claim-dependent string
maxLength: 1024
minLength: 1
type: string
Expand Down
Loading