Skip to content
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

Remove the deprecated ToolchainCluster.Spec fields #448

Merged
merged 8 commits into from
Oct 8, 2024
Merged

Remove the deprecated ToolchainCluster.Spec fields #448

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a9ad140
Deprecate all of the fields in ToolchainCluster.Spec apart from the link
metlos Sep 9, 2024
77bb59a
Merge remote-tracking branch 'upstream/master' into deprecate-tc-spec…
metlos Sep 13, 2024
e8d6a97
Removing the no longer used fields from the ToolchainCluster spec.
metlos Sep 17, 2024
6b959ea
Merge remote-tracking branch 'upstream/master' into deprecate-tc-spec…
metlos Sep 17, 2024
9d77cb8
Merge branch 'master' into deprecate-tc-spec-fields-contd5
MatousJobanek Oct 2, 2024
38feb7a
Remove the unused "enum constants".
metlos Oct 3, 2024
176149d
Merge remote-tracking branch 'origin/deprecate-tc-spec-fields-contd5'…
metlos Oct 3, 2024
c49a47f
Bring back the spec.apiEndpoint but make it optional.
metlos Oct 8, 2024
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
39 changes: 1 addition & 38 deletions api/v1alpha1/docs/apiref.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3063,20 +3063,6 @@ Supported condition types: ConditionReady + | |
|===


[id="{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-tlsvalidation"]
==== TLSValidation

_Underlying type:_ _string_





.Appears In:
****
- xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-toolchainclusterspec[$$ToolchainClusterSpec$$]
****



[id="{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-tiertemplate"]
Expand Down Expand Up @@ -3350,31 +3336,8 @@ ToolchainClusterSpec defines the desired state of ToolchainCluster
[cols="20a,50a,15a,15a", options="header"]
|===
| Field | Description | Default | Validation
| *`apiEndpoint`* __string__ | The API endpoint of the member cluster. This can be a hostname, +
hostname:port, IP or IP:port. +


Be aware that this field is going to be replaced with +
the Status.APIEndpoint in the future. + | |
| *`caBundle`* __string__ | CABundle contains the certificate authority information. +


Note that this is going to be deprecated and removed. It will be replaced by a field in +
the kubecondig of the connection secret + | |
| *`secretRef`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-localsecretreference[$$LocalSecretReference$$]__ | Name of the secret containing the token required to access the +
member cluster. The secret needs to exist in the same namespace +
as the control plane and should have a "token" key. +


In the near future, the secret will contain the whole kubeconfig required to connect +
| *`secretRef`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-localsecretreference[$$LocalSecretReference$$]__ | Name of the secret containing the kubeconfig required to connect +
to the cluster. + | |
| *`disabledTLSValidations`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-tlsvalidation[$$TLSValidation$$] array__ | DisabledTLSValidations defines a list of checks to ignore when validating +
the TLS connection to the member cluster. This can be any of *, SubjectName, or ValidityPeriod. +
If * is specified, it is expected to be the only option in list. +


Note that this is going to be deprecated and removed. It will be replaced by +
the kubeconfig stored in the connection secret. + | |
|===


Expand Down
39 changes: 1 addition & 38 deletions api/v1alpha1/toolchaincluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,49 +21,12 @@ const (
ToolchainClusterLabel = LabelKeyPrefix + "toolchain-cluster"
)

type TLSValidation string

const (
TLSAll TLSValidation = "*"
TLSSubjectName TLSValidation = "SubjectName"
TLSValidityPeriod TLSValidation = "ValidityPeriod"
)

// ToolchainClusterSpec defines the desired state of ToolchainCluster
// +k8s:openapi-gen=true
type ToolchainClusterSpec struct {
// The API endpoint of the member cluster. This can be a hostname,
// hostname:port, IP or IP:port.
//
// Be aware that this field is going to be replaced with
// the Status.APIEndpoint in the future.
APIEndpoint string `json:"apiEndpoint"`

// CABundle contains the certificate authority information.
// +optional
//
// Note that this is going to be deprecated and removed. It will be replaced by a field in
// the kubecondig of the connection secret
CABundle string `json:"caBundle,omitempty"`

// Name of the secret containing the token required to access the
// member cluster. The secret needs to exist in the same namespace
// as the control plane and should have a "token" key.
//
// In the near future, the secret will contain the whole kubeconfig required to connect
// Name of the secret containing the kubeconfig required to connect
// to the cluster.
SecretRef LocalSecretReference `json:"secretRef"`

// DisabledTLSValidations defines a list of checks to ignore when validating
// the TLS connection to the member cluster. This can be any of *, SubjectName, or ValidityPeriod.
// If * is specified, it is expected to be the only option in list.
//
// Note that this is going to be deprecated and removed. It will be replaced by
// the kubeconfig stored in the connection secret.
//
// +optional
// +listType=set
DisabledTLSValidations []TLSValidation `json:"disabledTLSValidations,omitempty"`
metlos marked this conversation as resolved.
Show resolved Hide resolved
}

// LocalSecretReference is a reference to a secret within the enclosing
Expand Down
7 changes: 1 addition & 6 deletions api/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

39 changes: 2 additions & 37 deletions api/v1alpha1/zz_generated.openapi.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading