Merge pull request openshift#6 from alexander-demichev/providerspec

Add API fields for initial implementation

.github/workflows/golangci-lint.yml

@@ -10,12 +10,11 @@ jobs:
       matrix:
         working-directory:
           - ""
-          - test
-          - hack/tools
     steps:
       - uses: actions/checkout@v2
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
           version: v1.43.0
           working-directory: ${{matrix.working-directory}}
+          args: --timeout 3m0s

api/v1alpha1/bootstrapprovider_types.go

@@ -32,6 +32,8 @@ type BootstrapProviderStatus struct {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.version"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 
 // BootstrapProvider is the Schema for the bootstrapproviders API.
 type BootstrapProvider struct {

api/v1alpha1/conditions_consts.go

@@ -23,6 +23,37 @@ const (
 	PreflightCheckCondition clusterv1.ConditionType = "PreflightCheckPassed"
 
 	// MoreThanOneProviderInstanceExistsReason (Severity=Info) documents that more than one instance of provider
-	// exists in the cluster
+	// exists in the cluster.
 	MoreThanOneProviderInstanceExistsReason = "MoreThanOneExists"
+
+	// IncorrectVersionFormatReason documents that the provider version is in the incorrect format.
+	IncorrectVersionFormatReason = "IncorrectVersionFormat"
+
+	// FetchConfigValidationError documents that the FetchConfig is configured incorrectly.
+	FetchConfigValidationErrorReason = "FetchConfigValidationError"
+
+	// UnknownProviderReason documents that the provider name is not the name of a known provider.
+	UnknownProviderReason = "UnknownProvider"
+
+	// CAPIVersionIncompatibility documents that the provider version is incompatible with operator.
+	CAPIVersionIncompatibilityReason = "CAPIVersionIncompatibility"
+
+	// ComponentsFetchErrorReason documents that an error occurred fetching the componets.
+	ComponentsFetchErrorReason = "ComponentsFetchError"
+
+	// OldComponentsDeletionErrorReason documents that an error occurred deleting the old components prior to upgrading.
+	OldComponentsDeletionErrorReason = "OldComponentsDeletionError"
+
+	// WaitingForCoreProviderReadyReason documents that the provider is waiting for the core provider to be ready.
+	WaitingForCoreProviderReadyReason = "WaitingForCoreProviderReady"
+)
+
+const (
+	// CertManagerReadyCondition documents a Provider that does not have dependent CertManager Ready.
+	CertManagerReadyCondition clusterv1.ConditionType = "CertManagerReady"
+)
+
+const (
+	// ProviderInstalledCondition documents a Provider that has been installed.
+	ProviderInstalledCondition clusterv1.ConditionType = "ProviderInstalled"
 )

api/v1alpha1/controlplaneprovider_types.go

@@ -32,6 +32,8 @@ type ControlPlaneProviderStatus struct {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.version"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 
 // ControlPlaneProvider is the Schema for the controlplaneproviders API.
 type ControlPlaneProvider struct {

api/v1alpha1/coreprovider_types.go

@@ -32,6 +32,8 @@ type CoreProviderStatus struct {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.version"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 
 // CoreProvider is the Schema for the coreproviders API.
 type CoreProvider struct {

api/v1alpha1/infrastructureprovider_types.go

@@ -32,6 +32,8 @@ type InfrastructureProviderStatus struct {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".spec.version"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 
 // InfrastructureProvider is the Schema for the infrastructureproviders API.
 type InfrastructureProvider struct {

api/v1alpha1/provider_types.go

@@ -16,17 +16,189 @@ limitations under the License.
 
 package v1alpha1
 
-import clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	ctrlconfigv1 "sigs.k8s.io/controller-runtime/pkg/config/v1alpha1"
 
-// TODO: NOTE: The API details will be incrementally added and will eventually
-// conform to the CAPI Provider CAEP.
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+)
 
-// ProProviderSpec is the desired state of the Provider.
-type ProviderSpec struct{}
+const (
+	ProviderFinalizer         = "provider.cluster.x-k8s.io"
+	ConfigMapVersionLabelName = "provider.cluster.x-k8s.io/version"
+)
+
+// ProviderSpec is the desired state of the Provider.
+type ProviderSpec struct {
+	// Version indicates the provider version.
+	// +optional
+	Version *string `json:"version,omitempty"`
+
+	// Manager defines the properties that can be enabled on the controller manager for the provider.
+	// +optional
+	Manager *ManagerSpec `json:"manager,omitempty"`
+
+	// Deployment defines the properties that can be enabled on the deployment for the provider.
+	// +optional
+	Deployment *DeploymentSpec `json:"deployment,omitempty"`
+
+	// SecretName is the name of the Secret providing the configuration
+	// variables for the current provider instance, like e.g. credentials.
+	// Such configurations will be used when creating or upgrading provider components.
+	// The contents of the secret will be treated as immutable. If changes need
+	// to be made, a new object can be created and the name should be updated.
+	// The contents should be in the form of key:value. This secret must be in
+	// the same namespace as the provider.
+	// +optional
+	SecretName *string `json:"secretName,omitempty"`
+
+	// FetchConfig determines how the operator will fetch the components and metadata for the provider.
+	// If nil, the operator will try to fetch components according to default
+	// embedded fetch configuration for the given kind and `ObjectMeta.Name`.
+	// For example, the infrastructure name `aws` will fetch artifacts from
+	// https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases.
+	// +optional
+	FetchConfig *FetchConfiguration `json:"fetchConfig,omitempty"`
+}
+
+// ManagerSpec defines the properties that can be enabled on the controller manager for the provider.
+type ManagerSpec struct {
+	// ControllerManagerConfigurationSpec defines the desired state of GenericControllerManagerConfiguration.
+	ctrlconfigv1.ControllerManagerConfigurationSpec `json:",inline"`
+
+	// ProfilerAddress defines the bind address to expose the pprof profiler (e.g. localhost:6060).
+	// Default empty, meaning the profiler is disabled.
+	// Controller Manager flag is --profiler-address.
+	// +optional
+	ProfilerAddress *string `json:"profilerAddress,omitempty"`
+
+	// MaxConcurrentReconciles is the maximum number of concurrent Reconciles
+	// which can be run. Defaults to 10.
+	// +optional
+	// +kubebuilder:default=10
+	// +kubebuilder:validation:Minimum=1
+	MaxConcurrentReconciles *int `json:"maxConcurrentReconciles,omitempty"`
+
+	// Verbosity set the logs verbosity. Defaults to 1.
+	// Controller Manager flag is --verbosity.
+	// +optional
+	// +kubebuilder:default=1
+	// +kubebuilder:validation:Minimum=0
+	Verbosity int `json:"verbosity,omitempty"`
+
+	// Debug, if set, will override a set of fields with opinionated values for
+	// a debugging session. (Verbosity=5, ProfilerAddress=localhost:6060)
+	// +optional
+	// +kubebuilder:default=false
+	Debug bool `json:"debug,omitempty"`
+
+	// FeatureGates define provider specific feature flags that will be passed
+	// in as container args to the provider's controller manager.
+	// Controller Manager flag is --feature-gates.
+	FeatureGates map[string]bool `json:"featureGates,omitempty"`
+}
+
+// DeploymentSpec defines the properties that can be enabled on the Deployment for the provider.
+type DeploymentSpec struct {
+	// Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
+	// +optional
+	// +kubebuilder:validation:Minimum=0
+	Replicas *int `json:"replicas,omitempty"`
+
+	// 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/
+	// +optional
+	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
+
+	// If specified, the pod's tolerations.
+	// +optional
+	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
+
+	// If specified, the pod's scheduling constraints
+	// +optional
+	Affinity *corev1.Affinity `json:"affinity,omitempty"`
+
+	// List of containers specified in the Deployment
+	// +optional
+	Containers []ContainerSpec `json:"containers"`
+}
+
+// ContainerSpec defines the properties available to override for each
+// container in a provider deployment such as Image and Args to the container’s
+// entrypoint.
+type ContainerSpec struct {
+	// Name of the container. Cannot be updated.
+	Name string `json:"name"`
+
+	// Container Image Name
+	// +optional
+	Image *ImageMeta `json:"image,omitempty"`
+
+	// Args represents extra provider specific flags that are not encoded as fields in this API.
+	// Explicit controller manager properties defined in the `Provider.ManagerSpec`
+	// will have higher precedence than those defined in `ContainerSpec.Args`.
+	// For example, `ManagerSpec.SyncPeriod` will be used instead of the
+	// container arg `--sync-period` if both are defined.
+	// The same holds for `ManagerSpec.FeatureGates` and `--feature-gates`.
+	// +optional
+	Args map[string]string `json:"args,omitempty"`
+
+	// List of environment variables to set in the container.
+	// +optional
+	Env []corev1.EnvVar `json:"env,omitempty"`
+
+	// Compute resources required by this container.
+	// +optional
+	Resources *corev1.ResourceRequirements `json:"resources,omitempty"`
+}
+
+// ImageMeta allows to customize the image used.
+type ImageMeta struct {
+	// Repository sets the container registry to pull images from.
+	// +optional
+	Repository *string `json:"repository,omitempty"`
+
+	// Name allows to specify a name for the image.
+	// +optional
+	Name *string `json:"name,omitempty"`
+
+	// Tag allows to specify a tag for the image.
+	// +optional
+	Tag *string `json:"tag,omitempty"`
+}
+
+// FetchConfiguration determines the way to fetch the components and metadata for the provider.
+type FetchConfiguration struct {
+	// URL to be used for fetching the provider’s components and metadata from a remote Github repository.
+	// For example, https://github.com/{owner}/{repository}/releases
+	// The version of the release will be `ProviderSpec.Version` if defined
+	// otherwise the `latest` version will be computed and used.
+	// +optional
+	URL *string `json:"url,omitempty"`
+
+	// Selector to be used for fetching provider’s components and metadata from
+	// ConfigMaps stored inside the cluster. Each ConfigMap is expected to contain
+	// components and metadata for a specific version only.
+	// Note: the name of the ConfigMap should be set to the version or to override this
+	// add a label like the following: provider.cluster.x-k8s.io/version=v1.4.3
+	// +optional
+	Selector *metav1.LabelSelector `json:"selector,omitempty"`
+}
 
 // ProProviderStatus defines the observed state of the Provider.
 type ProviderStatus struct {
+	// Contract will contain the core provider contract that the provider is
+	// abiding by, like e.g. v1alpha4.
+	// +optional
+	Contract *string `json:"contract,omitempty"`
+
 	// Conditions define the current service state of the provider.
 	// +optional
 	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
+
+	// ObservedGeneration is the latest generation observed by the controller.
+	// +optional
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }