github.com/banzaicloud/operator-tools@v0.28.10/docs/overrides/override.md (about)

     1  ## ObjectMeta
     2  
     3  ObjectMeta contains only a [subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta).
     4  
     5  ### annotations (map[string]string, optional) {#objectmeta-annotations}
     6  
     7  Default: -
     8  
     9  ### labels (map[string]string, optional) {#objectmeta-labels}
    10  
    11  Default: -
    12  
    13  
    14  ## Service
    15  
    16  Service is a subset of [Service in k8s.io/api/apps/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#service-v1-core) for embedding.
    17  
    18  ### metadata (ObjectMeta, optional) {#service-metadata}
    19  
    20  Default: -
    21  
    22  ### spec (v1.ServiceSpec, optional) {#service-spec}
    23  
    24  Kubernetes [Service Specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#servicespec-v1-core) 
    25  
    26  Default: -
    27  
    28  
    29  ## IngressExtensionsV1beta1
    30  
    31  IngressExtensionsV1beta1 is a subset of Ingress k8s.io/api/extensions/v1beta1 but is already deprecated
    32  
    33  ### metadata (ObjectMeta, optional) {#ingressextensionsv1beta1-metadata}
    34  
    35  Default: -
    36  
    37  ### spec (v1beta1.IngressSpec, optional) {#ingressextensionsv1beta1-spec}
    38  
    39  Default: -
    40  
    41  
    42  ## IngressNetworkingV1beta1
    43  
    44  IngressExtensionsV1beta1 is a subset of [Ingress in k8s.io/api/networking/v1beta1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingress-v1-networking-k8s-io).
    45  
    46  ### metadata (ObjectMeta, optional) {#ingressnetworkingv1beta1-metadata}
    47  
    48  Default: -
    49  
    50  ### spec (networkingv1beta1.IngressSpec, optional) {#ingressnetworkingv1beta1-spec}
    51  
    52  Kubernetes [Ingress Specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#ingressclassspec-v1-networking-k8s-io) 
    53  
    54  Default: -
    55  
    56  
    57  ## DaemonSet
    58  
    59  DaemonSet is a subset of [DaemonSet in k8s.io/api/apps/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#daemonset-v1-apps), with [DaemonSetSpec replaced by the local variant](#daemonset-spec).
    60  
    61  ### metadata (ObjectMeta, optional) {#daemonset-metadata}
    62  
    63  Default: -
    64  
    65  ### spec (DaemonSetSpec, optional) {#daemonset-spec}
    66  
    67  [Local DaemonSet specification](#daemonset-spec) 
    68  
    69  Default: -
    70  
    71  
    72  ## DaemonSetSpec
    73  
    74  DaemonSetSpec is a subset of [DaemonSetSpec in k8s.io/api/apps/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#daemonsetspec-v1-apps) but with required fields declared as optional
    75  and [PodTemplateSpec replaced by the local variant](#podtemplatespec).
    76  
    77  ### selector (*metav1.LabelSelector, optional) {#daemonsetspec-selector}
    78  
    79  A label query over pods that are managed by the daemon set. 
    80  
    81  Default: -
    82  
    83  ### template (PodTemplateSpec, optional) {#daemonsetspec-template}
    84  
    85  An object that describes the pod that will be created. Note that this is a [local PodTemplateSpec](#podtemplatespec) 
    86  
    87  Default: -
    88  
    89  ### updateStrategy (appsv1.DaemonSetUpdateStrategy, optional) {#daemonsetspec-updatestrategy}
    90  
    91  An update strategy to replace existing DaemonSet pods with new pods. 
    92  
    93  Default: -
    94  
    95  ### minReadySeconds (int32, optional) {#daemonsetspec-minreadyseconds}
    96  
    97  The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).  
    98  
    99  Default:  0
   100  
   101  ### revisionHistoryLimit (*int32, optional) {#daemonsetspec-revisionhistorylimit}
   102  
   103  The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.  
   104  
   105  Default:  10
   106  
   107  
   108  ## Deployment
   109  
   110  Deployment is a subset of [Deployment in k8s.io/api/apps/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#deployment-v1-apps), with [DeploymentSpec replaced by the local variant](#deployment-spec).
   111  
   112  ### metadata (ObjectMeta, optional) {#deployment-metadata}
   113  
   114  Default: -
   115  
   116  ### spec (DeploymentSpec, optional) {#deployment-spec}
   117  
   118  The desired behavior of [this deployment](#deploymentspec). 
   119  
   120  Default: -
   121  
   122  
   123  ## DeploymentSpec
   124  
   125  DeploymentSpec is a subset of [DeploymentSpec in k8s.io/api/apps/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#deploymentspec-v1-apps) but with required fields declared as optional
   126  and [PodTemplateSpec replaced by the local variant](#podtemplatespec).
   127  
   128  ### replicas (*int32, optional) {#deploymentspec-replicas}
   129  
   130  Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.  
   131  
   132  Default:  1
   133  
   134  ### selector (*metav1.LabelSelector, optional) {#deploymentspec-selector}
   135  
   136  Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. 
   137  
   138  Default: -
   139  
   140  ### template (PodTemplateSpec, optional) {#deploymentspec-template}
   141  
   142  An object that describes the pod that will be created. Note that this is a [local PodTemplateSpec](#podtemplatespec) 
   143  
   144  Default: -
   145  
   146  ### strategy (appsv1.DeploymentStrategy, optional) {#deploymentspec-strategy}
   147  
   148  The deployment strategy to use to replace existing pods with new ones. +patchStrategy=retainKeys 
   149  
   150  Default: -
   151  
   152  ### minReadySeconds (int32, optional) {#deploymentspec-minreadyseconds}
   153  
   154  Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)  
   155  
   156  Default:  0
   157  
   158  ### revisionHistoryLimit (*int32, optional) {#deploymentspec-revisionhistorylimit}
   159  
   160  The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.  
   161  
   162  Default:  10
   163  
   164  ### paused (bool, optional) {#deploymentspec-paused}
   165  
   166  Indicates that the deployment is paused. 
   167  
   168  Default: -
   169  
   170  ### progressDeadlineSeconds (*int32, optional) {#deploymentspec-progressdeadlineseconds}
   171  
   172  The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.  
   173  
   174  Default:  600
   175  
   176  
   177  ## StatefulSet
   178  
   179  StatefulSet is a subset of [StatefulSet in k8s.io/api/apps/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#statefulset-v1-apps), with [StatefulSetSpec replaced by the local variant](#statefulset-spec).
   180  
   181  ### metadata (ObjectMeta, optional) {#statefulset-metadata}
   182  
   183  Default: -
   184  
   185  ### spec (StatefulSetSpec, optional) {#statefulset-spec}
   186  
   187  Default: -
   188  
   189  
   190  ## StatefulSetSpec
   191  
   192  StatefulSetSpec is a subset of [StatefulSetSpec in k8s.io/api/apps/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#statefulsetspec-v1-apps) but with required fields declared as optional
   193  and [PodTemplateSpec](#podtemplatespec) and [PersistentVolumeClaim replaced by the local variant](#persistentvolumeclaim).
   194  
   195  ### replicas (*int32, optional) {#statefulsetspec-replicas}
   196  
   197  Replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.  +optional 
   198  
   199  Default:  1
   200  
   201  ### selector (*metav1.LabelSelector, optional) {#statefulsetspec-selector}
   202  
   203  Selector is a label query over pods that should match the replica count. It must match the pod template's labels. 
   204  
   205  Default: -
   206  
   207  ### template (PodTemplateSpec, optional) {#statefulsetspec-template}
   208  
   209  template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. 
   210  
   211  Default: -
   212  
   213  ### volumeClaimTemplates ([]PersistentVolumeClaim, optional) {#statefulsetspec-volumeclaimtemplates}
   214  
   215  volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. +optional 
   216  
   217  Default: -
   218  
   219  ### serviceName (string, optional) {#statefulsetspec-servicename}
   220  
   221  serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. 
   222  
   223  Default: -
   224  
   225  ### podManagementPolicy (appsv1.PodManagementPolicyType, optional) {#statefulsetspec-podmanagementpolicy}
   226  
   227  podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.  +optional 
   228  
   229  Default:  OrderedReady
   230  
   231  ### updateStrategy (appsv1.StatefulSetUpdateStrategy, optional) {#statefulsetspec-updatestrategy}
   232  
   233  updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. 
   234  
   235  Default: -
   236  
   237  ### revisionHistoryLimit (*int32, optional) {#statefulsetspec-revisionhistorylimit}
   238  
   239  revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.  
   240  
   241  Default:  10
   242  
   243  
   244  ## PersistentVolumeClaim
   245  
   246  PersistentVolumeClaim is a subset of [PersistentVolumeClaim in k8s.io/api/core/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#persistentvolumeclaim-v1-core).
   247  
   248  ### metadata (EmbeddedPersistentVolumeClaimObjectMeta, optional) {#persistentvolumeclaim-metadata}
   249  
   250  Default: -
   251  
   252  ### spec (v1.PersistentVolumeClaimSpec, optional) {#persistentvolumeclaim-spec}
   253  
   254  Default: -
   255  
   256  
   257  ## EmbeddedPersistentVolumeClaimObjectMeta
   258  
   259  ObjectMeta contains only a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta
   260  Only fields which are relevant to embedded PVCs are included
   261  controller-gen discards embedded ObjectMetadata type fields, so we have to overcome this.
   262  
   263  ### name (string, optional) {#embeddedpersistentvolumeclaimobjectmeta-name}
   264  
   265  Default: -
   266  
   267  ### annotations (map[string]string, optional) {#embeddedpersistentvolumeclaimobjectmeta-annotations}
   268  
   269  Default: -
   270  
   271  ### labels (map[string]string, optional) {#embeddedpersistentvolumeclaimobjectmeta-labels}
   272  
   273  Default: -
   274  
   275  
   276  ## PodTemplateSpec
   277  
   278  PodTemplateSpec describes the data a pod should have when created from a template
   279  It's the same as [PodTemplateSpec in k8s.io/api/core/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#podtemplatespec-v1-core) but with the [local ObjectMeta](#objectmeta) and [PodSpec](#podspec) types embedded.
   280  
   281  ### metadata (ObjectMeta, optional) {#podtemplatespec-metadata}
   282  
   283  Default: -
   284  
   285  ### spec (PodSpec, optional) {#podtemplatespec-spec}
   286  
   287  Default: -
   288  
   289  
   290  ## PodSpec
   291  
   292  PodSpec is a subset of [PodSpec in k8s.io/api/corev1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#podspec-v1-core). It's the same as the original PodSpec expect it allows for containers to be missing.
   293  
   294  ### volumes ([]v1.Volume, optional) {#podspec-volumes}
   295  
   296  List of volumes that can be mounted by containers belonging to the pod. +patchMergeKey=name +patchStrategy=merge,retainKeys 
   297  
   298  Default: -
   299  
   300  ### initContainers ([]v1.Container, optional) {#podspec-initcontainers}
   301  
   302  List of initialization containers belonging to the pod. +patchMergeKey=name +patchStrategy=merge 
   303  
   304  Default: -
   305  
   306  ### containers ([]v1.Container, optional) {#podspec-containers}
   307  
   308  List of containers belonging to the pod. +patchMergeKey=name +patchStrategy=merge 
   309  
   310  Default: -
   311  
   312  ### ephemeralContainers ([]v1.EphemeralContainer, optional) {#podspec-ephemeralcontainers}
   313  
   314  List of ephemeral containers run in this pod. +patchMergeKey=name +patchStrategy=merge 
   315  
   316  Default: -
   317  
   318  ### restartPolicy (v1.RestartPolicy, optional) {#podspec-restartpolicy}
   319  
   320  Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always.  
   321  
   322  Default:  Always
   323  
   324  ### terminationGracePeriodSeconds (*int64, optional) {#podspec-terminationgraceperiodseconds}
   325  
   326  Optional duration in seconds the pod needs to terminate gracefully. Defaults to 30 seconds.  
   327  
   328  Default:  30
   329  
   330  ### activeDeadlineSeconds (*int64, optional) {#podspec-activedeadlineseconds}
   331  
   332  Optional duration in seconds the pod may be active on the node relative to 
   333  
   334  Default: -
   335  
   336  ### dnsPolicy (v1.DNSPolicy, optional) {#podspec-dnspolicy}
   337  
   338  Set DNS policy for the pod. Defaults to "ClusterFirst".  Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. 
   339  
   340  Default:  ClusterFirst
   341  
   342  ### nodeSelector (map[string]string, optional) {#podspec-nodeselector}
   343  
   344  NodeSelector is a selector which must be true for the pod to fit on a node. 
   345  
   346  Default: -
   347  
   348  ### serviceAccountName (string, optional) {#podspec-serviceaccountname}
   349  
   350  ServiceAccountName is the name of the ServiceAccount to use to run this pod. 
   351  
   352  Default: -
   353  
   354  ### automountServiceAccountToken (*bool, optional) {#podspec-automountserviceaccounttoken}
   355  
   356  AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. 
   357  
   358  Default: -
   359  
   360  ### nodeName (string, optional) {#podspec-nodename}
   361  
   362  NodeName is a request to schedule this pod onto a specific node. 
   363  
   364  Default: -
   365  
   366  ### hostNetwork (bool, optional) {#podspec-hostnetwork}
   367  
   368  Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.  
   369  
   370  Default:  false
   371  
   372  ### hostPID (bool, optional) {#podspec-hostpid}
   373  
   374  Use the host's pid namespace. Optional: Default to false.  
   375  
   376  Default:  false
   377  
   378  ### hostIPC (bool, optional) {#podspec-hostipc}
   379  
   380  Use the host's ipc namespace. Optional: Default to false.  
   381  
   382  Default:  false
   383  
   384  ### shareProcessNamespace (*bool, optional) {#podspec-shareprocessnamespace}
   385  
   386  Share a single process namespace between all of the containers in a pod. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.  
   387  
   388  Default:  false
   389  
   390  ### securityContext (*v1.PodSecurityContext, optional) {#podspec-securitycontext}
   391  
   392  SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty.  See type description for default values of each field. 
   393  
   394  Default: -
   395  
   396  ### imagePullSecrets ([]v1.LocalObjectReference, optional) {#podspec-imagepullsecrets}
   397  
   398  ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. +patchMergeKey=name +patchStrategy=merge 
   399  
   400  Default: -
   401  
   402  ### hostname (string, optional) {#podspec-hostname}
   403  
   404  Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. 
   405  
   406  Default: -
   407  
   408  ### subdomain (string, optional) {#podspec-subdomain}
   409  
   410  If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. 
   411  
   412  Default: -
   413  
   414  ### affinity (*v1.Affinity, optional) {#podspec-affinity}
   415  
   416  If specified, the pod's scheduling constraints 
   417  
   418  Default: -
   419  
   420  ### schedulerName (string, optional) {#podspec-schedulername}
   421  
   422  If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. 
   423  
   424  Default: -
   425  
   426  ### tolerations ([]v1.Toleration, optional) {#podspec-tolerations}
   427  
   428  If specified, the pod's tolerations. 
   429  
   430  Default: -
   431  
   432  ### hostAliases ([]v1.HostAlias, optional) {#podspec-hostaliases}
   433  
   434  HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. +patchMergeKey=ip +patchStrategy=merge 
   435  
   436  Default: -
   437  
   438  ### priorityClassName (string, optional) {#podspec-priorityclassname}
   439  
   440  If specified, indicates the pod's priority. 
   441  
   442  Default: -
   443  
   444  ### priority (*int32, optional) {#podspec-priority}
   445  
   446  The priority value. Various system components use this field to find the priority of the pod. 
   447  
   448  Default: -
   449  
   450  ### dnsConfig (*v1.PodDNSConfig, optional) {#podspec-dnsconfig}
   451  
   452  Specifies the DNS parameters of a pod. 
   453  
   454  Default: -
   455  
   456  ### readinessGates ([]v1.PodReadinessGate, optional) {#podspec-readinessgates}
   457  
   458  If specified, all readiness gates will be evaluated for pod readiness. 
   459  
   460  Default: -
   461  
   462  ### runtimeClassName (*string, optional) {#podspec-runtimeclassname}
   463  
   464  RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. 
   465  
   466  Default: -
   467  
   468  ### enableServiceLinks (*bool, optional) {#podspec-enableservicelinks}
   469  
   470  EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.  
   471  
   472  Default:  true
   473  
   474  ### preemptionPolicy (*v1.PreemptionPolicy, optional) {#podspec-preemptionpolicy}
   475  
   476  PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.  
   477  
   478  Default:  PreemptLowerPriority
   479  
   480  ### overhead (v1.ResourceList, optional) {#podspec-overhead}
   481  
   482  Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. 
   483  
   484  Default: -
   485  
   486  ### topologySpreadConstraints ([]v1.TopologySpreadConstraint, optional) {#podspec-topologyspreadconstraints}
   487  
   488  TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. +patchMergeKey=topologyKey +patchStrategy=merge +listType=map +listMapKey=topologyKey +listMapKey=whenUnsatisfiable 
   489  
   490  Default: -
   491  
   492  ### setHostnameAsFQDN (*bool, optional) {#podspec-sethostnameasfqdn}
   493  
   494  If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). Default to false.  +optional 
   495  
   496  Default:  false
   497  
   498  
   499  ## ServiceAccount
   500  
   501  ServiceAccount is a subset of [ServiceAccount in k8s.io/api/core/v1](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#serviceaccount-v1-core).
   502  
   503  ### metadata (ObjectMeta, optional) {#serviceaccount-metadata}
   504  
   505  +optional 
   506  
   507  Default: -
   508  
   509  ### secrets ([]v1.ObjectReference, optional) {#serviceaccount-secrets}
   510  
   511  +optional +patchMergeKey=name +patchStrategy=merge 
   512  
   513  Default: -
   514  
   515  ### imagePullSecrets ([]v1.LocalObjectReference, optional) {#serviceaccount-imagepullsecrets}
   516  
   517  +optional 
   518  
   519  Default: -
   520  
   521  ### automountServiceAccountToken (*bool, optional) {#serviceaccount-automountserviceaccounttoken}
   522  
   523  +optional 
   524  
   525  Default: -
   526  
   527