Skip to content

Update CRD descriptions #1184

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
gianlucam76 merged 1 commit into from
May 7, 2025
Merged

Update CRD descriptions #1184

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
23 changes: 7 additions & 16 deletions api/v1beta1/spec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,12 @@ type ValueFrom struct {
// For ClusterProfile namespace can be left empty. In such a case, namespace will
// be implicit set to cluster's namespace.
// For Profile namespace must be left empty. The Profile namespace will be used.
// Namespace can be expressed as a template and instantiate using any cluster field.
// +optional
Namespace string `json:"namespace,omitempty"`

// Name of the referenced resource.
// Name can be expressed as a template and instantiate using
// - cluster namespace: .Cluster.metadata.namespace
// - cluster name: .Cluster.metadata.name
// - cluster type: .Cluster.kind
// Name can be expressed as a template and instantiate using any cluster field.
// +kubebuilder:validation:MinLength=1
Name string `json:"name"`

Expand Down Expand Up @@ -464,13 +462,11 @@ type KustomizationRef struct {
// For ClusterProfile namespace can be left empty. In such a case, namespace will
// be implicit set to cluster's namespace.
// For Profile namespace must be left empty. The Profile namespace will be used.
// Namespace can be expressed as a template and instantiate using any cluster field.
Namespace string `json:"namespace"`

// Name of the referenced resource.
// Name can be expressed as a template and instantiate using
// - cluster namespace: .Cluster.metadata.namespace
// - cluster name: .Cluster.metadata.name
// - cluster type: .Cluster.kind
// Name can be expressed as a template and instantiate using any cluster field.
// +kubebuilder:validation:MinLength=1
Name string `json:"name"`

Expand Down Expand Up @@ -557,10 +553,7 @@ type TemplateResourceRef struct {
// cluster to fetch and use during template instantiation.
// For ClusterProfile namespace can be left empty. In such a case, namespace will
// be implicit set to cluster's namespace.
// Name and namespace can be expressed as a template and instantiate using
// - cluster namespace: .Cluster.metadata.namespace
// - cluster name: .Cluster.metadata.name
// - cluster type: .Cluster.kind
// Name and namespace can be expressed as a template and instantiate using any cluster field.
Resource corev1.ObjectReference `json:"resource"`

// Identifier is how the resource will be referred to in the
Expand All @@ -573,14 +566,12 @@ type PolicyRef struct {
// For ClusterProfile namespace can be left empty. In such a case, namespace will
// be implicit set to cluster's namespace.
// For Profile namespace must be left empty. Profile namespace will be used.
// Namespace can be expressed as a template and instantiate using any cluster field.
// +optional
Namespace string `json:"namespace,omitempty"`

// Name of the referenced resource.
// Name can be expressed as a template and instantiate using
// - cluster namespace: .Cluster.metadata.namespace
// - cluster name: .Cluster.metadata.name
// - cluster type: .Cluster.kind
// Name can be expressed as a template and instantiate using any cluster field.
// +kubebuilder:validation:MinLength=1
Name string `json:"name"`

Expand Down
29 changes: 9 additions & 20 deletions config/crd/bases/config.projectsveltos.io_clusterprofiles.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,10 +573,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -585,6 +582,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
required:
- kind
Expand Down Expand Up @@ -647,10 +645,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -659,6 +654,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
path:
description: |-
Expand Down Expand Up @@ -725,10 +721,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -737,6 +730,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
required:
- kind
Expand Down Expand Up @@ -867,10 +861,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -879,6 +870,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
path:
description: |-
Expand Down Expand Up @@ -959,10 +951,7 @@ spec:
cluster to fetch and use during template instantiation.
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
Name and namespace can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name and namespace can be expressed as a template and instantiate using any cluster field.
properties:
apiVersion:
description: API version of the referent.
Expand Down
29 changes: 9 additions & 20 deletions config/crd/bases/config.projectsveltos.io_clustersummaries.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -611,10 +611,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -623,6 +620,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
required:
- kind
Expand Down Expand Up @@ -685,10 +683,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -697,6 +692,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
path:
description: |-
Expand Down Expand Up @@ -763,10 +759,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -775,6 +768,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
required:
- kind
Expand Down Expand Up @@ -905,10 +899,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -917,6 +908,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
path:
description: |-
Expand Down Expand Up @@ -997,10 +989,7 @@ spec:
cluster to fetch and use during template instantiation.
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
Name and namespace can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name and namespace can be expressed as a template and instantiate using any cluster field.
properties:
apiVersion:
description: API version of the referent.
Expand Down
29 changes: 9 additions & 20 deletions config/crd/bases/config.projectsveltos.io_profiles.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,10 +573,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -585,6 +582,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
required:
- kind
Expand Down Expand Up @@ -647,10 +645,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -659,6 +654,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
path:
description: |-
Expand Down Expand Up @@ -725,10 +721,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -737,6 +730,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. The Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
required:
- kind
Expand Down Expand Up @@ -867,10 +861,7 @@ spec:
name:
description: |-
Name of the referenced resource.
Name can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name can be expressed as a template and instantiate using any cluster field.
minLength: 1
type: string
namespace:
Expand All @@ -879,6 +870,7 @@ spec:
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
For Profile namespace must be left empty. Profile namespace will be used.
Namespace can be expressed as a template and instantiate using any cluster field.
type: string
path:
description: |-
Expand Down Expand Up @@ -959,10 +951,7 @@ spec:
cluster to fetch and use during template instantiation.
For ClusterProfile namespace can be left empty. In such a case, namespace will
be implicit set to cluster's namespace.
Name and namespace can be expressed as a template and instantiate using
- cluster namespace: .Cluster.metadata.namespace
- cluster name: .Cluster.metadata.name
- cluster type: .Cluster.kind
Name and namespace can be expressed as a template and instantiate using any cluster field.
properties:
apiVersion:
description: API version of the referent.
Expand Down
Loading