crds_types.go

/*
Copyright 2019 The KubeCarrier Authors.

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 v1alpha1

import (
	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
)

// CRDInformation contains type information about the CRD.
type CRDInformation struct {
	Name     string       `json:"name"`
	APIGroup string       `json:"apiGroup"`
	Kind     string       `json:"kind"`
	Plural   string       `json:"plural"`
	Versions []CRDVersion `json:"versions"`

	// Region references a Region of this CRD.
	Region ObjectReference `json:"region"`
}

// CRDVersion holds CRD version specific details.
type CRDVersion struct {
	// Name of this version, for example: v1, v1alpha1, v1beta1
	Name string `json:"name"`

	// Schema of this CRD version.
	// +kubebuilder:pruning:PreserveUnknownFields
	Schema *apiextensionsv1.CustomResourceValidation `json:"schema,omitempty"`

	// Storage indicates this version should be used when persisting custom resources to storage.
	// There must be exactly one version with storage=true.
	Storage bool `json:"storage,omitempty"`
}