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

     1  ## ObjectKey
     2  
     3  ### name (string, optional) {#objectkey-name}
     4  
     5  Default: -
     6  
     7  ### namespace (string, optional) {#objectkey-namespace}
     8  
     9  Default: -
    10  
    11  
    12  ## EnabledComponent
    13  
    14  EnabledComponent implements the "enabled component" pattern
    15  Embed this type into other component types to avoid unnecessary code duplication
    16  NOTE: Don't forget to annotate the embedded field with `json:",inline"` tag for controller-gen
    17  
    18  ### enabled (*bool, optional) {#enabledcomponent-enabled}
    19  
    20  Default: -
    21  
    22  
    23  ## MetaBase
    24  
    25  Deprecated
    26  Consider using ObjectMeta in the typeoverrides package combined with the merge package
    27  
    28  ### annotations (map[string]string, optional) {#metabase-annotations}
    29  
    30  Default: -
    31  
    32  ### labels (map[string]string, optional) {#metabase-labels}
    33  
    34  Default: -
    35  
    36  
    37  ## PodTemplateBase
    38  
    39  Deprecated
    40  Consider using PodTemplateSpec in the typeoverrides package combined with the merge package
    41  
    42  ### metadata (*MetaBase, optional) {#podtemplatebase-metadata}
    43  
    44  Default: -
    45  
    46  ### spec (*PodSpecBase, optional) {#podtemplatebase-spec}
    47  
    48  Default: -
    49  
    50  
    51  ## ContainerBase
    52  
    53  Deprecated
    54  Consider using Container in the typeoverrides package combined with the merge package
    55  
    56  ### name (string, optional) {#containerbase-name}
    57  
    58  Default: -
    59  
    60  ### resources (*corev1.ResourceRequirements, optional) {#containerbase-resources}
    61  
    62  Default: -
    63  
    64  ### image (string, optional) {#containerbase-image}
    65  
    66  Default: -
    67  
    68  ### pullPolicy (corev1.PullPolicy, optional) {#containerbase-pullpolicy}
    69  
    70  Default: -
    71  
    72  ### command ([]string, optional) {#containerbase-command}
    73  
    74  Default: -
    75  
    76  ### volumeMounts ([]corev1.VolumeMount, optional) {#containerbase-volumemounts}
    77  
    78  Default: -
    79  
    80  ### securityContext (*corev1.SecurityContext, optional) {#containerbase-securitycontext}
    81  
    82  Default: -
    83  
    84  ### livenessProbe (*corev1.Probe, optional) {#containerbase-livenessprobe}
    85  
    86  Default: -
    87  
    88  ### readinessProbe (*corev1.Probe, optional) {#containerbase-readinessprobe}
    89  
    90  Default: -
    91  
    92  
    93  ## PodSpecBase
    94  
    95  Deprecated
    96  Consider using PodSpec in the typeoverrides package combined with the merge package
    97  
    98  ### tolerations ([]corev1.Toleration, optional) {#podspecbase-tolerations}
    99  
   100  Default: -
   101  
   102  ### nodeSelector (map[string]string, optional) {#podspecbase-nodeselector}
   103  
   104  Default: -
   105  
   106  ### serviceAccountName (string, optional) {#podspecbase-serviceaccountname}
   107  
   108  Default: -
   109  
   110  ### affinity (*corev1.Affinity, optional) {#podspecbase-affinity}
   111  
   112  Default: -
   113  
   114  ### securityContext (*corev1.PodSecurityContext, optional) {#podspecbase-securitycontext}
   115  
   116  Default: -
   117  
   118  ### volumes ([]corev1.Volume, optional) {#podspecbase-volumes}
   119  
   120  Default: -
   121  
   122  ### priorityClassName (string, optional) {#podspecbase-priorityclassname}
   123  
   124  Default: -
   125  
   126  ### containers ([]ContainerBase, optional) {#podspecbase-containers}
   127  
   128  Default: -
   129  
   130  ### initContainers ([]ContainerBase, optional) {#podspecbase-initcontainers}
   131  
   132  Default: -
   133  
   134  ### imagePullSecrets ([]corev1.LocalObjectReference, optional) {#podspecbase-imagepullsecrets}
   135  
   136  Default: -
   137  
   138  
   139  ## DeploymentBase
   140  
   141  Deprecated
   142  Consider using Deployment in the typeoverrides package combined with the merge package
   143  
   144  ###  (*MetaBase, required) {#deploymentbase-}
   145  
   146  Default: -
   147  
   148  ### spec (*DeploymentSpecBase, optional) {#deploymentbase-spec}
   149  
   150  Default: -
   151  
   152  
   153  ## DeploymentSpecBase
   154  
   155  Deprecated
   156  Consider using DeploymentSpec in the typeoverrides package combined with the merge package
   157  
   158  ### replicas (*int32, optional) {#deploymentspecbase-replicas}
   159  
   160  Default: -
   161  
   162  ### selector (*metav1.LabelSelector, optional) {#deploymentspecbase-selector}
   163  
   164  Default: -
   165  
   166  ### strategy (*appsv1.DeploymentStrategy, optional) {#deploymentspecbase-strategy}
   167  
   168  Default: -
   169  
   170  ### template (*PodTemplateBase, optional) {#deploymentspecbase-template}
   171  
   172  Default: -
   173  
   174  
   175  ## StatefulSetBase
   176  
   177  Deprecated
   178  Consider using StatefulSet in the typeoverrides package combined with the merge package
   179  
   180  ###  (*MetaBase, required) {#statefulsetbase-}
   181  
   182  Default: -
   183  
   184  ### spec (*StatefulsetSpecBase, optional) {#statefulsetbase-spec}
   185  
   186  Default: -
   187  
   188  
   189  ## StatefulsetSpecBase
   190  
   191  Deprecated
   192  Consider using StatefulSetSpec in the typeoverrides package combined with the merge package
   193  
   194  ### replicas (*int32, optional) {#statefulsetspecbase-replicas}
   195  
   196  Default: -
   197  
   198  ### selector (*metav1.LabelSelector, optional) {#statefulsetspecbase-selector}
   199  
   200  Default: -
   201  
   202  ### podManagementPolicy (appsv1.PodManagementPolicyType, optional) {#statefulsetspecbase-podmanagementpolicy}
   203  
   204  Default: -
   205  
   206  ### updateStrategy (*appsv1.StatefulSetUpdateStrategy, optional) {#statefulsetspecbase-updatestrategy}
   207  
   208  Default: -
   209  
   210  ### template (*PodTemplateBase, optional) {#statefulsetspecbase-template}
   211  
   212  Default: -
   213  
   214  
   215  ## DaemonSetBase
   216  
   217  Deprecated
   218  Consider using DaemonSet in the typeoverrides package combined with the merge package
   219  
   220  ###  (*MetaBase, required) {#daemonsetbase-}
   221  
   222  Default: -
   223  
   224  ### spec (*DaemonSetSpecBase, optional) {#daemonsetbase-spec}
   225  
   226  Default: -
   227  
   228  
   229  ## DaemonSetSpecBase
   230  
   231  Deprecated
   232  Consider using DaemonSetSpec in the typeoverrides package combined with the merge package
   233  
   234  ### selector (*metav1.LabelSelector, optional) {#daemonsetspecbase-selector}
   235  
   236  Default: -
   237  
   238  ### updateStrategy (*appsv1.DaemonSetUpdateStrategy, optional) {#daemonsetspecbase-updatestrategy}
   239  
   240  Default: -
   241  
   242  ### minReadySeconds (int32, optional) {#daemonsetspecbase-minreadyseconds}
   243  
   244  Default: -
   245  
   246  ### revisionHistoryLimit (*int32, optional) {#daemonsetspecbase-revisionhistorylimit}
   247  
   248  Default: -
   249  
   250  ### template (*PodTemplateBase, optional) {#daemonsetspecbase-template}
   251  
   252  Default: -
   253  
   254