Skip to content

Commit

Permalink
Add v1beta1 CRD version for replication* types
Browse files Browse the repository at this point in the history
This commit add v1beta1 CRD version for the replication objects
and also update the CRD manifests.

Addition to that, bundle version has been updated to v0.0.2

boilerplate header has been updated to reflect current year.

Fix: csi-addons#122

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
  • Loading branch information
humblec committed Jun 9, 2022
1 parent caf40c2 commit 7683a02
Show file tree
Hide file tree
Showing 8 changed files with 670 additions and 37 deletions.
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# To re-generate a bundle for another specific version without changing the standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
VERSION ?= 0.0.1
VERSION ?= 0.0.2

# CHANNELS define the bundle channels used in the bundle.
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "preview,fast,stable")
Expand Down Expand Up @@ -34,7 +34,7 @@ IMG_TAG ?= latest
IMG=${IMG_NAME}:${IMG_TAG}
image_arch_list=linux/amd64,linux/ppc64le,linux/s390x
# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
CRD_OPTIONS ?= "crd:trivialVersions=true,preserveUnknownFields=false"
CRD_OPTIONS ?= ""

# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
ifeq (,$(shell go env GOBIN))
Expand Down Expand Up @@ -79,7 +79,7 @@ undeploy:

# Generate manifests e.g. CRD, RBAC etc.
manifests: controller-gen
$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
$(CONTROLLER_GEN) rbac:roleName=manager-role paths="api/..." output:crd:dir=config/crd/bases

# Run go fmt against code
fmt:
Expand All @@ -91,7 +91,7 @@ vet:

# Generate code
generate: controller-gen
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="api/..."

# Build the docker image
docker-build: test
Expand Down
36 changes: 36 additions & 0 deletions api/v1beta1/groupversion_info.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copyright 2022.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Package v1beta1 contains API Schema definitions for the replication v1beta1 API group
// +kubebuilder:object:generate=true
// +groupName=replication.storage.openshift.io
package v1beta1

import (
"k8s.io/apimachinery/pkg/runtime/schema"
"sigs.k8s.io/controller-runtime/pkg/scheme"
)

var (
// GroupVersion is group version used to register these objects.
GroupVersion = schema.GroupVersion{Group: "replication.storage.openshift.io", Version: "v1beta1"}

// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

// AddToScheme adds the types in this group-version to the given scheme.
AddToScheme = SchemeBuilder.AddToScheme
)
115 changes: 115 additions & 0 deletions api/v1beta1/volumereplication_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/*
Copyright 2022.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1beta1

import (
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// ReplicationState represents the replication operations to be performed on the volume.
// +kubebuilder:validation:Enum=primary;secondary;resync
type ReplicationState string

const (
// Primary ReplicationState enables mirroring and promotes the volume to primary.
Primary ReplicationState = "primary"

// Secondary ReplicationState demotes the volume to secondary and resyncs the volume if out of sync.
Secondary ReplicationState = "secondary"

// Resync option resyncs the volume.
Resync ReplicationState = "resync"
)

// State captures the latest state of the replication operation.
type State string

const (
// PrimaryState represents the Primary replication state.
PrimaryState State = "Primary"

// SecondaryState represents the Secondary replication state.
SecondaryState State = "Secondary"

// UnknownState represents the Unknown replication state.
UnknownState State = "Unknown"
)

// VolumeReplicationSpec defines the desired state of VolumeReplication.
type VolumeReplicationSpec struct {
// VolumeReplicationClass is the VolumeReplicationClass name for this VolumeReplication resource
// +kubebuilder:validation:Required
VolumeReplicationClass string `json:"volumeReplicationClass"`

// ReplicationState represents the replication operation to be performed on the volume.
// Supported operations are "primary", "secondary" and "resync"
// +kubebuilder:validation:Required
ReplicationState ReplicationState `json:"replicationState"`

// DataSource represents the object associated with the volume
// +kubebuilder:validation:Required
DataSource corev1.TypedLocalObjectReference `json:"dataSource"`

// replicationHandle represents an existing (but new) replication id
// +kubebuilder:validation:Optional
ReplicationHandle string `json:"replicationHandle"`
}

// VolumeReplicationStatus defines the observed state of VolumeReplication.
type VolumeReplicationStatus struct {
State State `json:"state,omitempty"`
Message string `json:"message,omitempty"`
// Conditions are the list of conditions and their status.
Conditions []metav1.Condition `json:"conditions,omitempty"`
// observedGeneration is the last generation change the operator has dealt with
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
LastStartTime *metav1.Time `json:"lastStartTime,omitempty"`
LastCompletionTime *metav1.Time `json:"lastCompletionTime,omitempty"`
}

// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:JSONPath=".metadata.creationTimestamp",name=Age,type=date
// +kubebuilder:printcolumn:JSONPath=".spec.volumeReplicationClass",name=volumeReplicationClass,type=string
// +kubebuilder:printcolumn:JSONPath=".spec.dataSource.name",name=pvcName,type=string
// +kubebuilder:printcolumn:JSONPath=".spec.replicationState",name=desiredState,type=string
// +kubebuilder:printcolumn:JSONPath=".status.state",name=currentState,type=string
// +kubebuilder:resource:shortName=vr

// VolumeReplication is the Schema for the volumereplications API.
type VolumeReplication struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec VolumeReplicationSpec `json:"spec,omitempty"`
Status VolumeReplicationStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true

// VolumeReplicationList contains a list of VolumeReplication.
type VolumeReplicationList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []VolumeReplication `json:"items"`
}

func init() {
SchemeBuilder.Register(&VolumeReplication{}, &VolumeReplicationList{})
}
64 changes: 64 additions & 0 deletions api/v1beta1/volumereplicationclass_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/*
Copyright 2022.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1beta1

import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// VolumeReplicationClassSpec specifies parameters that an underlying storage system uses
// when creating a volume replica. A specific VolumeReplicationClass is used by specifying
// its name in a VolumeReplication object.
type VolumeReplicationClassSpec struct {
// Provisioner is the name of storage provisioner
// +kubebuilder:validation:Required
Provisioner string `json:"provisioner"`
// Parameters is a key-value map with storage provisioner specific configurations for
// creating volume replicas
// +kubebuilder:validation:Optional
Parameters map[string]string `json:"parameters,omitempty"`
}

// VolumeReplicationClassStatus defines the observed state of VolumeReplicationClass.
type VolumeReplicationClassStatus struct{}

// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:resource:scope=Cluster,shortName=vrc
// +kubebuilder:printcolumn:JSONPath=".spec.provisioner",name=provisioner,type=string

// VolumeReplicationClass is the Schema for the volumereplicationclasses API.
type VolumeReplicationClass struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec VolumeReplicationClassSpec `json:"spec,omitempty"`
Status VolumeReplicationClassStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true

// VolumeReplicationClassList contains a list of VolumeReplicationClass.
type VolumeReplicationClassList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []VolumeReplicationClass `json:"items"`
}

func init() {
SchemeBuilder.Register(&VolumeReplicationClass{}, &VolumeReplicationClassList{})
}
Loading

0 comments on commit 7683a02

Please sign in to comment.