github.com/ironcore-dev/gardener-extension-provider-ironcore@v0.3.2-0.20240314231816-8336447fb9a0/hack/api-reference/config.md (about)

     1  <p>Packages:</p>
     2  <ul>
     3  <li>
     4  <a href="#%09ironcore.provider.extensions.config.gardener.cloud%2fv1alpha1">	ironcore.provider.extensions.config.gardener.cloud/v1alpha1</a>
     5  </li>
     6  </ul>
     7  <h2 id="	ironcore.provider.extensions.config.gardener.cloud/v1alpha1">	ironcore.provider.extensions.config.gardener.cloud/v1alpha1</h2>
     8  <p>
     9  <p>Package v1alpha1 contains the ironcore provider configuration API resources.</p>
    10  </p>
    11  Resource Types:
    12  <ul><li>
    13  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ControllerConfiguration">ControllerConfiguration</a>
    14  </li></ul>
    15  <h3 id="	ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ControllerConfiguration">ControllerConfiguration
    16  </h3>
    17  <p>
    18  <p>ControllerConfiguration defines the configuration for the ironcore provider.</p>
    19  </p>
    20  <table>
    21  <thead>
    22  <tr>
    23  <th>Field</th>
    24  <th>Description</th>
    25  </tr>
    26  </thead>
    27  <tbody>
    28  <tr>
    29  <td>
    30  <code>apiVersion</code></br>
    31  string</td>
    32  <td>
    33  <code>
    34  ironcore.provider.extensions.config.gardener.cloud/v1alpha1
    35  </code>
    36  </td>
    37  </tr>
    38  <tr>
    39  <td>
    40  <code>kind</code></br>
    41  string
    42  </td>
    43  <td><code>ControllerConfiguration</code></td>
    44  </tr>
    45  <tr>
    46  <td>
    47  <code>clientConnection</code></br>
    48  <em>
    49  <a href="https://godoc.org/k8s.io/component-base/config/v1alpha1#ClientConnectionConfiguration">
    50  Kubernetes v1alpha1.ClientConnectionConfiguration
    51  </a>
    52  </em>
    53  </td>
    54  <td>
    55  <em>(Optional)</em>
    56  <p>ClientConnection specifies the kubeconfig file and client connection
    57  settings for the proxy server to use when communicating with the apiserver.</p>
    58  </td>
    59  </tr>
    60  <tr>
    61  <td>
    62  <code>etcd</code></br>
    63  <em>
    64  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCD">
    65  ETCD
    66  </a>
    67  </em>
    68  </td>
    69  <td>
    70  <p>ETCD is the etcd configuration.</p>
    71  </td>
    72  </tr>
    73  <tr>
    74  <td>
    75  <code>healthCheckConfig</code></br>
    76  <em>
    77  <a href="https://github.com/gardener/gardener/extensions/pkg/apis/config">
    78  github.com/gardener/gardener/extensions/pkg/apis/config/v1alpha1.HealthCheckConfig
    79  </a>
    80  </em>
    81  </td>
    82  <td>
    83  <em>(Optional)</em>
    84  <p>HealthCheckConfig is the config for the health check controller</p>
    85  </td>
    86  </tr>
    87  <tr>
    88  <td>
    89  <code>featureGates</code></br>
    90  <em>
    91  map[string]bool
    92  </em>
    93  </td>
    94  <td>
    95  <em>(Optional)</em>
    96  <p>FeatureGates is a map of feature names to bools that enable
    97  or disable alpha/experimental features.
    98  Default: nil</p>
    99  </td>
   100  </tr>
   101  <tr>
   102  <td>
   103  <code>bastionConfig</code></br>
   104  <em>
   105  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.BastionConfig">
   106  BastionConfig
   107  </a>
   108  </em>
   109  </td>
   110  <td>
   111  <em>(Optional)</em>
   112  <p>BastionConfig is the config for the Bastion</p>
   113  </td>
   114  </tr>
   115  <tr>
   116  <td>
   117  <code>backupBucketConfig</code></br>
   118  <em>
   119  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.BackupBucketConfig">
   120  BackupBucketConfig
   121  </a>
   122  </em>
   123  </td>
   124  <td>
   125  <p>BackupBucketConfig is config for Backup Bucket</p>
   126  </td>
   127  </tr>
   128  </tbody>
   129  </table>
   130  <h3 id="	ironcore.provider.extensions.config.gardener.cloud/v1alpha1.BackupBucketConfig">BackupBucketConfig
   131  </h3>
   132  <p>
   133  (<em>Appears on:</em>
   134  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ControllerConfiguration">ControllerConfiguration</a>)
   135  </p>
   136  <p>
   137  <p>BackupBucketConfig is config for Backup Bucket</p>
   138  </p>
   139  <table>
   140  <thead>
   141  <tr>
   142  <th>Field</th>
   143  <th>Description</th>
   144  </tr>
   145  </thead>
   146  <tbody>
   147  <tr>
   148  <td>
   149  <code>bucketClassName</code></br>
   150  <em>
   151  string
   152  </em>
   153  </td>
   154  <td>
   155  <p>BucketClassName is the name of the ironcore BucketClass to use for the BackupBucket</p>
   156  </td>
   157  </tr>
   158  </tbody>
   159  </table>
   160  <h3 id="	ironcore.provider.extensions.config.gardener.cloud/v1alpha1.BastionConfig">BastionConfig
   161  </h3>
   162  <p>
   163  (<em>Appears on:</em>
   164  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ControllerConfiguration">ControllerConfiguration</a>)
   165  </p>
   166  <p>
   167  <p>BastionConfig is the config for the Bastion</p>
   168  </p>
   169  <table>
   170  <thead>
   171  <tr>
   172  <th>Field</th>
   173  <th>Description</th>
   174  </tr>
   175  </thead>
   176  <tbody>
   177  <tr>
   178  <td>
   179  <code>image</code></br>
   180  <em>
   181  string
   182  </em>
   183  </td>
   184  <td>
   185  <p>Image is the URL pointing to an OCI registry containing the operating system image which should be used to boot the Bastion host</p>
   186  </td>
   187  </tr>
   188  <tr>
   189  <td>
   190  <code>machineClassName</code></br>
   191  <em>
   192  string
   193  </em>
   194  </td>
   195  <td>
   196  <p>MachineClassName is the name of the ironcore MachineClass to use for the Bastion host</p>
   197  </td>
   198  </tr>
   199  <tr>
   200  <td>
   201  <code>volumeClassName</code></br>
   202  <em>
   203  string
   204  </em>
   205  </td>
   206  <td>
   207  <p>VolumeClassName is the name of the ironcore VolumeClass to use for the Bastion host root disk volume</p>
   208  </td>
   209  </tr>
   210  </tbody>
   211  </table>
   212  <h3 id="	ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCD">ETCD
   213  </h3>
   214  <p>
   215  (<em>Appears on:</em>
   216  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ControllerConfiguration">ControllerConfiguration</a>)
   217  </p>
   218  <p>
   219  <p>ETCD is an etcd configuration.</p>
   220  </p>
   221  <table>
   222  <thead>
   223  <tr>
   224  <th>Field</th>
   225  <th>Description</th>
   226  </tr>
   227  </thead>
   228  <tbody>
   229  <tr>
   230  <td>
   231  <code>storage</code></br>
   232  <em>
   233  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCDStorage">
   234  ETCDStorage
   235  </a>
   236  </em>
   237  </td>
   238  <td>
   239  <p>ETCDStorage is the etcd storage configuration.</p>
   240  </td>
   241  </tr>
   242  <tr>
   243  <td>
   244  <code>backup</code></br>
   245  <em>
   246  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCDBackup">
   247  ETCDBackup
   248  </a>
   249  </em>
   250  </td>
   251  <td>
   252  <p>ETCDBackup is the etcd backup configuration.</p>
   253  </td>
   254  </tr>
   255  </tbody>
   256  </table>
   257  <h3 id="	ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCDBackup">ETCDBackup
   258  </h3>
   259  <p>
   260  (<em>Appears on:</em>
   261  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCD">ETCD</a>)
   262  </p>
   263  <p>
   264  <p>ETCDBackup is an etcd backup configuration.</p>
   265  </p>
   266  <table>
   267  <thead>
   268  <tr>
   269  <th>Field</th>
   270  <th>Description</th>
   271  </tr>
   272  </thead>
   273  <tbody>
   274  <tr>
   275  <td>
   276  <code>schedule</code></br>
   277  <em>
   278  string
   279  </em>
   280  </td>
   281  <td>
   282  <em>(Optional)</em>
   283  <p>Schedule is the etcd backup schedule.</p>
   284  </td>
   285  </tr>
   286  </tbody>
   287  </table>
   288  <h3 id="	ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCDStorage">ETCDStorage
   289  </h3>
   290  <p>
   291  (<em>Appears on:</em>
   292  <a href="#%09ironcore.provider.extensions.config.gardener.cloud/v1alpha1.ETCD">ETCD</a>)
   293  </p>
   294  <p>
   295  <p>ETCDStorage is an etcd storage configuration.</p>
   296  </p>
   297  <table>
   298  <thead>
   299  <tr>
   300  <th>Field</th>
   301  <th>Description</th>
   302  </tr>
   303  </thead>
   304  <tbody>
   305  <tr>
   306  <td>
   307  <code>className</code></br>
   308  <em>
   309  string
   310  </em>
   311  </td>
   312  <td>
   313  <em>(Optional)</em>
   314  <p>ClassName is the name of the storage class used in etcd-main volume claims.</p>
   315  </td>
   316  </tr>
   317  <tr>
   318  <td>
   319  <code>capacity</code></br>
   320  <em>
   321  <a href="https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity">
   322  k8s.io/apimachinery/pkg/api/resource.Quantity
   323  </a>
   324  </em>
   325  </td>
   326  <td>
   327  <em>(Optional)</em>
   328  <p>Capacity is the storage capacity used in etcd-main volume claims.</p>
   329  </td>
   330  </tr>
   331  </tbody>
   332  </table>
   333  <hr/>
   334  <p><em>
   335  Generated with <a href="https://github.com/ahmetb/gen-crd-api-reference-docs">gen-crd-api-reference-docs</a>
   336  </em></p>