custom_resource_definition.go

/*
Copyright (C) 2018 Synopsys, Inc.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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 api

import (
	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
)

// CRDConfig defines the configuration for a custom defined resource
type CRDConfig struct {
	Name                              string
	Namespace                         string
	APIVersion                        string
	ClusterName                       string
	Group                             string
	CRDVersion                        string
	Plural                            string
	Singular                          string
	ShortNames                        []string
	Kind                              string
	ListKind                          string
	Categories                        []string
	ScaleSubresources                 *CRDScaleSubresources
	Versions                          []CRDVersion
	Validation                        *apiext.JSONSchemaProps
	Scope                             CRDScopeType
	ExtraColumns                      []CRDColumn
	ConversionStrategy                CRDConversionStraegyType
	ConversionWebhookURL              *string
	ConversionWebhookServiceNamespace string
	ConversionWebhookServiceName      string
	ConversionWebhookServicePath      *string
	ConversionWebhookCABundle         []byte
	ConversionReviewVersions          []string
}

// CRDScopeType defines the scope of the custom resource definition
type CRDScopeType int

const (
	CRDClusterScoped CRDScopeType = iota + 1
	CRDNamespaceScoped
)

// CRDVersion defines a version for a custom resource definition
type CRDVersion struct {
	Name              string
	Enabled           bool
	Storage           bool
	Schema            *apiext.JSONSchemaProps
	ScaleSubresources *CRDScaleSubresources
	ExtraColumns      []CRDColumn
}

// CRDScaleSubresources defines how to serve the scale subresource for the scale subresource of custom resources
type CRDScaleSubresources struct {
	SpecPath     string
	StatusPath   string
	SelectorPath *string
}

// CRDColumn specifies a column for server side printing of a custom resource definition
type CRDColumn struct {
	Name        string
	Type        string
	Format      string
	Description string
	Priority    int32
	Path        string
}

// CRDConversionStraegyType defines the type of conversion strategy for the custom resource
type CRDConversionStraegyType int

const (
	CRDConversionStraegyTypeNone CRDConversionStraegyType = iota + 1
	CRDConversionStraegyTypeWebhook
)