certServiceK8sExternalProvider/src/cmpv2api/cmpv2_issuer_crd_schema.go

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * oom-certservice-k8s-external-provider
   4  * ================================================================================
   5  * Copyright (c) 2019 Smallstep Labs, Inc.
   6  * Modifications copyright (C) 2020 Nokia. All rights reserved.
   7  * ================================================================================
   8  * This source code was copied from the following git repository:
   9  * https://github.com/smallstep/step-issuer
  10  * The source code was modified for usage in the ONAP project.
  11  * ================================================================================
  12  * Licensed under the Apache License, Version 2.0 (the "License");
  13  * you may not use this file except in compliance with the License.
  14  * You may obtain a copy of the License at
  15  *
  16  *      http://www.apache.org/licenses/LICENSE-2.0
  17  *
  18  * Unless required by applicable law or agreed to in writing, software
  19  * distributed under the License is distributed on an "AS IS" BASIS,
  20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  * See the License for the specific language governing permissions and
  22  * limitations under the License.
  23  * ============LICENSE_END=========================================================
  24  */
  25
  26 package cmpv2api
  27
  28 import (
  29         metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  30 )
  31
  32 func init() {
  33         SchemeBuilder.Register(&CMPv2Issuer{}, &CMPv2IssuerList{})
  34 }
  35
  36 // CMPv2IssuerSpec defines the desired state of CMPv2Issuer
  37 type CMPv2IssuerSpec struct {
  38         // URL is the base URL for the CertService certificates instance.
  39         URL string `json:"url"`
  40         // CaName is the name of the external CA server
  41         CaName string `json:"caName"`
  42         // KeyRef is a reference to a Secret containing the provisioner
  43         CertSecretRef SecretKeySelector `json:"certSecretRef"`
  44 }
  45
  46 // CMPv2IssuerStatus defines the observed state of CMPv2Issuer
  47 type CMPv2IssuerStatus struct {
  48
  49         // +optional
  50         Conditions []CMPv2IssuerCondition `json:"conditions,omitempty"`
  51 }
  52
  53 type CMPv2Issuer struct {
  54         metav1.TypeMeta   `json:",inline"`
  55         metav1.ObjectMeta `json:"metadata,omitempty"`
  56
  57         Spec   CMPv2IssuerSpec   `json:"spec,omitempty"`
  58         Status CMPv2IssuerStatus `json:"status,omitempty"`
  59 }
  60
  61 // +kubebuilder:object:root=true
  62
  63 // CMPv2IssuerList contains a list of CMPv2Issuer
  64 type CMPv2IssuerList struct {
  65         metav1.TypeMeta `json:",inline"`
  66         metav1.ListMeta `json:"metadata,omitempty"`
  67         Items           []CMPv2Issuer `json:"items"`
  68 }
  69
  70 // SecretKeySelector contains the reference to a secret.
  71 type SecretKeySelector struct {
  72         // The name of the secret in the pod's namespace to select from.
  73         Name string `json:"name"`
  74
  75         // The key of the secret to select private key from. Must be a valid secret key.
  76         KeyRef string `json:"keyRef,omitempty"`
  77         // The key of the secret to select cert from. Must be a valid secret key.
  78         CertRef string `json:"certRef,omitempty"`
  79         // The key of the secret to select cacert from. Must be a valid secret key.
  80         CacertRef string `json:"cacertRef,omitempty"`
  81 }
  82
  83 // ConditionType represents a CMPv2Issuer condition type.
  84 // +kubebuilder:validation:Enum=Ready
  85 type ConditionType string
  86
  87 const (
  88         // ConditionReady indicates that a CMPv2Issuer is ready for use.
  89         ConditionReady ConditionType = "Ready"
  90 )
  91
  92 // ConditionStatus represents a condition's status.
  93 // +kubebuilder:validation:Enum=True;False;Unknown
  94 type ConditionStatus string
  95
  96 // These are valid condition statuses. "ConditionTrue" means a resource is in
  97 // the condition; "ConditionFalse" means a resource is not in the condition;
  98 // "ConditionUnknown" means kubernetes can't decide if a resource is in the
  99 // condition or not. In the future, we could add other intermediate
 100 // conditions, e.g. ConditionDegraded.
 101 const (
 102         // ConditionTrue represents the fact that a given condition is true
 103         ConditionTrue ConditionStatus = "True"
 104
 105         // ConditionFalse represents the fact that a given condition is false
 106         ConditionFalse ConditionStatus = "False"
 107
 108         // ConditionUnknown represents the fact that a given condition is unknown
 109         ConditionUnknown ConditionStatus = "Unknown"
 110 )
 111
 112 // CMPv2IssuerCondition contains condition information for the CertService issuer.
 113 type CMPv2IssuerCondition struct {
 114         // Type of the condition, currently ('Ready').
 115         Type ConditionType `json:"type"`
 116
 117         // Status of the condition, one of ('True', 'False', 'Unknown').
 118         // +kubebuilder:validation:Enum=True;False;Unknown
 119         Status ConditionStatus `json:"status"`
 120
 121         // LastTransitionTime is the timestamp corresponding to the last status
 122         // change of this condition.
 123         // +optional
 124         LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
 125
 126         // Reason is a brief machine readable explanation for the condition's last
 127         // transition.
 128         // +optional
 129         Reason string `json:"reason,omitempty"`
 130
 131         // Message is a human readable description of the details of the last
 132         // transition, complementing reason.
 133         // +optional
 134         Message string `json:"message,omitempty"`
 135 }