airshipctl/pkg/api/v1alpha1/phase_types.go
Ruslan Aliev bc9f97ff2e Embed validation cfg into phase and plan definition
* validation config is now part of airshipctl api
 * additional CRD locations can be only kustomize entrypoints
 * changed mechanism to call document-validation executor to allow
   to pass validation config from phase or plan
 * kubeval version pinned to the latest 0.16.1
 * default k8s version to validate against uplifted to 1.18.6
 * default URL with k8s schemas changed to more updated and reliable

Change-Id: Ifb24be224d5f0860d323a671b94e28a86debc65b
Signed-off-by: Ruslan Aliev <raliev@mirantis.com>
Closes: #563
2021-06-11 15:37:38 +00:00

70 lines
2.5 KiB
Go

/*
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
https://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 (
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// +kubebuilder:object:root=true
// Phase object to control deployment steps
type Phase struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Config PhaseConfig `json:"config,omitempty"`
}
// PhaseConfig represents configuration for a particular phase. It contains a reference to
// phase runner object which should contain runner configuration and validation configuration
type PhaseConfig struct {
ExecutorRef *corev1.ObjectReference `json:"executorRef"`
SiteWideKubeconfig bool `json:"siteWideKubeconfig,omitempty"`
ValidationCfg ValidationConfig `json:"validation"`
DocumentEntryPoint string `json:"documentEntryPoint"`
}
// ValidationConfig represents configuration needed for static validation
type ValidationConfig struct {
// Strict disallows additional properties not in schema if set
Strict *bool `json:"strict,omitempty"`
// IgnoreMissingSchemas skips validation for resource
// definitions without a schema.
IgnoreMissingSchemas *bool `json:"ignoreMissingSchemas,omitempty"`
// KubernetesVersion is the version of Kubernetes to validate
// against (default "1.18.6").
KubernetesVersion string `json:"kubernetesVersion,omitempty"`
// SchemaLocation is the base URL from which to search for schemas.
// It can be either a remote location or a local directory
SchemaLocation string `json:"schemaLocation,omitempty"`
// KindsToSkip defines Kinds which will be skipped during validation
KindsToSkip []string `json:"kindsToSkip,omitempty"`
// CRDList defines list of kustomize entrypoints located in "TARGET_PATH" where to find additional CRD
CRDList []string `json:"crdList,omitempty"`
}
// DefaultPhase can be used to safely unmarshal phase object without nil pointers
func DefaultPhase() *Phase {
return &Phase{
Config: PhaseConfig{},
}
}