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

     1  <p>Packages:</p>
     2  <ul>
     3  <li>
     4  <a href="#ironcore.provider.extensions.gardener.cloud%2fv1alpha1">ironcore.provider.extensions.gardener.cloud/v1alpha1</a>
     5  </li>
     6  </ul>
     7  <h2 id="ironcore.provider.extensions.gardener.cloud/v1alpha1">ironcore.provider.extensions.gardener.cloud/v1alpha1</h2>
     8  <p>
     9  <p>Package v1alpha1 contains the ironcore provider API resources.</p>
    10  </p>
    11  Resource Types:
    12  <ul><li>
    13  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.CloudProfileConfig">CloudProfileConfig</a>
    14  </li><li>
    15  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.ControlPlaneConfig">ControlPlaneConfig</a>
    16  </li><li>
    17  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.InfrastructureConfig">InfrastructureConfig</a>
    18  </li></ul>
    19  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.CloudProfileConfig">CloudProfileConfig
    20  </h3>
    21  <p>
    22  <p>CloudProfileConfig contains provider-specific configuration that is embedded into Gardener&rsquo;s <code>CloudProfile</code>
    23  resource.</p>
    24  </p>
    25  <table>
    26  <thead>
    27  <tr>
    28  <th>Field</th>
    29  <th>Description</th>
    30  </tr>
    31  </thead>
    32  <tbody>
    33  <tr>
    34  <td>
    35  <code>apiVersion</code></br>
    36  string</td>
    37  <td>
    38  <code>
    39  ironcore.provider.extensions.gardener.cloud/v1alpha1
    40  </code>
    41  </td>
    42  </tr>
    43  <tr>
    44  <td>
    45  <code>kind</code></br>
    46  string
    47  </td>
    48  <td><code>CloudProfileConfig</code></td>
    49  </tr>
    50  <tr>
    51  <td>
    52  <code>machineImages</code></br>
    53  <em>
    54  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.MachineImages">
    55  []MachineImages
    56  </a>
    57  </em>
    58  </td>
    59  <td>
    60  <p>MachineImages is the list of machine images that are understood by the controller. It maps
    61  logical names and versions to provider-specific identifiers.</p>
    62  </td>
    63  </tr>
    64  <tr>
    65  <td>
    66  <code>regionConfigs</code></br>
    67  <em>
    68  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.RegionConfig">
    69  []RegionConfig
    70  </a>
    71  </em>
    72  </td>
    73  <td>
    74  <p>RegionConfigs is the list of supported regions.</p>
    75  </td>
    76  </tr>
    77  <tr>
    78  <td>
    79  <code>storageClasses</code></br>
    80  <em>
    81  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.StorageClasses">
    82  StorageClasses
    83  </a>
    84  </em>
    85  </td>
    86  <td>
    87  <em>(Optional)</em>
    88  <p>StorageClasses defines the DefaultStrorageClass and AdditionalStoreClasses for the shoot</p>
    89  </td>
    90  </tr>
    91  </tbody>
    92  </table>
    93  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.ControlPlaneConfig">ControlPlaneConfig
    94  </h3>
    95  <p>
    96  <p>ControlPlaneConfig contains configuration settings for the control plane.</p>
    97  </p>
    98  <table>
    99  <thead>
   100  <tr>
   101  <th>Field</th>
   102  <th>Description</th>
   103  </tr>
   104  </thead>
   105  <tbody>
   106  <tr>
   107  <td>
   108  <code>apiVersion</code></br>
   109  string</td>
   110  <td>
   111  <code>
   112  ironcore.provider.extensions.gardener.cloud/v1alpha1
   113  </code>
   114  </td>
   115  </tr>
   116  <tr>
   117  <td>
   118  <code>kind</code></br>
   119  string
   120  </td>
   121  <td><code>ControlPlaneConfig</code></td>
   122  </tr>
   123  <tr>
   124  <td>
   125  <code>cloudControllerManager</code></br>
   126  <em>
   127  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.CloudControllerManagerConfig">
   128  CloudControllerManagerConfig
   129  </a>
   130  </em>
   131  </td>
   132  <td>
   133  <em>(Optional)</em>
   134  <p>CloudControllerManager contains configuration settings for the cloud-controller-manager.</p>
   135  </td>
   136  </tr>
   137  </tbody>
   138  </table>
   139  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.InfrastructureConfig">InfrastructureConfig
   140  </h3>
   141  <p>
   142  <p>InfrastructureConfig infrastructure configuration resource</p>
   143  </p>
   144  <table>
   145  <thead>
   146  <tr>
   147  <th>Field</th>
   148  <th>Description</th>
   149  </tr>
   150  </thead>
   151  <tbody>
   152  <tr>
   153  <td>
   154  <code>apiVersion</code></br>
   155  string</td>
   156  <td>
   157  <code>
   158  ironcore.provider.extensions.gardener.cloud/v1alpha1
   159  </code>
   160  </td>
   161  </tr>
   162  <tr>
   163  <td>
   164  <code>kind</code></br>
   165  string
   166  </td>
   167  <td><code>InfrastructureConfig</code></td>
   168  </tr>
   169  <tr>
   170  <td>
   171  <code>networkRef</code></br>
   172  <em>
   173  <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#localobjectreference-v1-core">
   174  Kubernetes core/v1.LocalObjectReference
   175  </a>
   176  </em>
   177  </td>
   178  <td>
   179  <p>NetworkRef references the network to use for the Shoot creation.</p>
   180  </td>
   181  </tr>
   182  </tbody>
   183  </table>
   184  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.CloudControllerManagerConfig">CloudControllerManagerConfig
   185  </h3>
   186  <p>
   187  (<em>Appears on:</em>
   188  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.ControlPlaneConfig">ControlPlaneConfig</a>)
   189  </p>
   190  <p>
   191  <p>CloudControllerManagerConfig contains configuration settings for the cloud-controller-manager.</p>
   192  </p>
   193  <table>
   194  <thead>
   195  <tr>
   196  <th>Field</th>
   197  <th>Description</th>
   198  </tr>
   199  </thead>
   200  <tbody>
   201  <tr>
   202  <td>
   203  <code>featureGates</code></br>
   204  <em>
   205  map[string]bool
   206  </em>
   207  </td>
   208  <td>
   209  <em>(Optional)</em>
   210  <p>FeatureGates contains information about enabled feature gates.</p>
   211  </td>
   212  </tr>
   213  </tbody>
   214  </table>
   215  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.InfrastructureStatus">InfrastructureStatus
   216  </h3>
   217  <p>
   218  <p>InfrastructureStatus contains information about created infrastructure resources.</p>
   219  </p>
   220  <table>
   221  <thead>
   222  <tr>
   223  <th>Field</th>
   224  <th>Description</th>
   225  </tr>
   226  </thead>
   227  <tbody>
   228  <tr>
   229  <td>
   230  <code>networkRef</code></br>
   231  <em>
   232  <a href="https://github.com/ironcore-dev/ironcore/blob/main/docs/api-reference/common.md#localuidreference">
   233  github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference
   234  </a>
   235  </em>
   236  </td>
   237  <td>
   238  <p>NetworkRef is the reference to the networked used</p>
   239  </td>
   240  </tr>
   241  <tr>
   242  <td>
   243  <code>natGatewayRef</code></br>
   244  <em>
   245  <a href="https://github.com/ironcore-dev/ironcore/blob/main/docs/api-reference/common.md#localuidreference">
   246  github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference
   247  </a>
   248  </em>
   249  </td>
   250  <td>
   251  <p>NATGatewayRef is the reference to the NAT gateway used</p>
   252  </td>
   253  </tr>
   254  <tr>
   255  <td>
   256  <code>prefixRef</code></br>
   257  <em>
   258  <a href="https://github.com/ironcore-dev/ironcore/blob/main/docs/api-reference/common.md#localuidreference">
   259  github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference
   260  </a>
   261  </em>
   262  </td>
   263  <td>
   264  <p>PrefixRef is the reference to the Prefix used</p>
   265  </td>
   266  </tr>
   267  </tbody>
   268  </table>
   269  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.MachineImage">MachineImage
   270  </h3>
   271  <p>
   272  (<em>Appears on:</em>
   273  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.WorkerStatus">WorkerStatus</a>)
   274  </p>
   275  <p>
   276  <p>MachineImage is a mapping from logical names and versions to ironcore-specific identifiers.</p>
   277  </p>
   278  <table>
   279  <thead>
   280  <tr>
   281  <th>Field</th>
   282  <th>Description</th>
   283  </tr>
   284  </thead>
   285  <tbody>
   286  <tr>
   287  <td>
   288  <code>name</code></br>
   289  <em>
   290  string
   291  </em>
   292  </td>
   293  <td>
   294  <p>Name is the logical name of the machine image.</p>
   295  </td>
   296  </tr>
   297  <tr>
   298  <td>
   299  <code>version</code></br>
   300  <em>
   301  string
   302  </em>
   303  </td>
   304  <td>
   305  <p>Version is the logical version of the machine image.</p>
   306  </td>
   307  </tr>
   308  <tr>
   309  <td>
   310  <code>image</code></br>
   311  <em>
   312  string
   313  </em>
   314  </td>
   315  <td>
   316  <p>Image is the path to the image.</p>
   317  </td>
   318  </tr>
   319  <tr>
   320  <td>
   321  <code>architecture</code></br>
   322  <em>
   323  string
   324  </em>
   325  </td>
   326  <td>
   327  <em>(Optional)</em>
   328  <p>Architecture is the CPU architecture of the machine image.</p>
   329  </td>
   330  </tr>
   331  </tbody>
   332  </table>
   333  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.MachineImageVersion">MachineImageVersion
   334  </h3>
   335  <p>
   336  (<em>Appears on:</em>
   337  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.MachineImages">MachineImages</a>)
   338  </p>
   339  <p>
   340  <p>MachineImageVersion contains a version and a provider-specific identifier.</p>
   341  </p>
   342  <table>
   343  <thead>
   344  <tr>
   345  <th>Field</th>
   346  <th>Description</th>
   347  </tr>
   348  </thead>
   349  <tbody>
   350  <tr>
   351  <td>
   352  <code>version</code></br>
   353  <em>
   354  string
   355  </em>
   356  </td>
   357  <td>
   358  <p>Version is the version of the image.</p>
   359  </td>
   360  </tr>
   361  <tr>
   362  <td>
   363  <code>image</code></br>
   364  <em>
   365  string
   366  </em>
   367  </td>
   368  <td>
   369  <p>Image is the path to the image.</p>
   370  </td>
   371  </tr>
   372  <tr>
   373  <td>
   374  <code>architecture</code></br>
   375  <em>
   376  string
   377  </em>
   378  </td>
   379  <td>
   380  <em>(Optional)</em>
   381  <p>Architecture is the CPU architecture of the machine image.</p>
   382  </td>
   383  </tr>
   384  </tbody>
   385  </table>
   386  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.MachineImages">MachineImages
   387  </h3>
   388  <p>
   389  (<em>Appears on:</em>
   390  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.CloudProfileConfig">CloudProfileConfig</a>)
   391  </p>
   392  <p>
   393  <p>MachineImages is a mapping from logical names and versions to provider-specific identifiers.</p>
   394  </p>
   395  <table>
   396  <thead>
   397  <tr>
   398  <th>Field</th>
   399  <th>Description</th>
   400  </tr>
   401  </thead>
   402  <tbody>
   403  <tr>
   404  <td>
   405  <code>name</code></br>
   406  <em>
   407  string
   408  </em>
   409  </td>
   410  <td>
   411  <p>Name is the logical name of the machine image.</p>
   412  </td>
   413  </tr>
   414  <tr>
   415  <td>
   416  <code>versions</code></br>
   417  <em>
   418  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.MachineImageVersion">
   419  []MachineImageVersion
   420  </a>
   421  </em>
   422  </td>
   423  <td>
   424  <p>Versions contains versions and a provider-specific identifier.</p>
   425  </td>
   426  </tr>
   427  </tbody>
   428  </table>
   429  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.RegionConfig">RegionConfig
   430  </h3>
   431  <p>
   432  (<em>Appears on:</em>
   433  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.CloudProfileConfig">CloudProfileConfig</a>)
   434  </p>
   435  <p>
   436  <p>RegionConfig is the definition of a region.</p>
   437  </p>
   438  <table>
   439  <thead>
   440  <tr>
   441  <th>Field</th>
   442  <th>Description</th>
   443  </tr>
   444  </thead>
   445  <tbody>
   446  <tr>
   447  <td>
   448  <code>name</code></br>
   449  <em>
   450  string
   451  </em>
   452  </td>
   453  <td>
   454  <p>Name is the name of a region.</p>
   455  </td>
   456  </tr>
   457  <tr>
   458  <td>
   459  <code>server</code></br>
   460  <em>
   461  string
   462  </em>
   463  </td>
   464  <td>
   465  <p>Server is the server endpoint of this region.</p>
   466  </td>
   467  </tr>
   468  <tr>
   469  <td>
   470  <code>certificateAuthorityData</code></br>
   471  <em>
   472  []byte
   473  </em>
   474  </td>
   475  <td>
   476  <p>CertificateAuthorityData is the CA data of the region server.</p>
   477  </td>
   478  </tr>
   479  </tbody>
   480  </table>
   481  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.StorageClass">StorageClass
   482  </h3>
   483  <p>
   484  (<em>Appears on:</em>
   485  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.StorageClasses">StorageClasses</a>)
   486  </p>
   487  <p>
   488  <p>StorageClass is a definition of a storageClass</p>
   489  </p>
   490  <table>
   491  <thead>
   492  <tr>
   493  <th>Field</th>
   494  <th>Description</th>
   495  </tr>
   496  </thead>
   497  <tbody>
   498  <tr>
   499  <td>
   500  <code>name</code></br>
   501  <em>
   502  string
   503  </em>
   504  </td>
   505  <td>
   506  <p>Name is the name of the storageclass</p>
   507  </td>
   508  </tr>
   509  <tr>
   510  <td>
   511  <code>type</code></br>
   512  <em>
   513  string
   514  </em>
   515  </td>
   516  <td>
   517  <p>Type is referring to the VolumeClass to use for this StorageClass</p>
   518  </td>
   519  </tr>
   520  </tbody>
   521  </table>
   522  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.StorageClasses">StorageClasses
   523  </h3>
   524  <p>
   525  (<em>Appears on:</em>
   526  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.CloudProfileConfig">CloudProfileConfig</a>)
   527  </p>
   528  <p>
   529  <p>StorageClasses is a definition of a storageClasses</p>
   530  </p>
   531  <table>
   532  <thead>
   533  <tr>
   534  <th>Field</th>
   535  <th>Description</th>
   536  </tr>
   537  </thead>
   538  <tbody>
   539  <tr>
   540  <td>
   541  <code>default</code></br>
   542  <em>
   543  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.StorageClass">
   544  StorageClass
   545  </a>
   546  </em>
   547  </td>
   548  <td>
   549  <em>(Optional)</em>
   550  <p>Default defines the default storage class for the shoot</p>
   551  </td>
   552  </tr>
   553  <tr>
   554  <td>
   555  <code>additional</code></br>
   556  <em>
   557  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.StorageClass">
   558  []StorageClass
   559  </a>
   560  </em>
   561  </td>
   562  <td>
   563  <em>(Optional)</em>
   564  <p>Additional defines the additional storage classes for the shoot</p>
   565  </td>
   566  </tr>
   567  </tbody>
   568  </table>
   569  <h3 id="ironcore.provider.extensions.gardener.cloud/v1alpha1.WorkerStatus">WorkerStatus
   570  </h3>
   571  <p>
   572  <p>WorkerStatus contains information about created worker resources.</p>
   573  </p>
   574  <table>
   575  <thead>
   576  <tr>
   577  <th>Field</th>
   578  <th>Description</th>
   579  </tr>
   580  </thead>
   581  <tbody>
   582  <tr>
   583  <td>
   584  <code>machineImages</code></br>
   585  <em>
   586  <a href="#ironcore.provider.extensions.gardener.cloud/v1alpha1.MachineImage">
   587  []MachineImage
   588  </a>
   589  </em>
   590  </td>
   591  <td>
   592  <em>(Optional)</em>
   593  <p>MachineImages is a list of machine images that have been used in this worker. Usually, the extension controller
   594  gets the mapping from name/version to the provider-specific machine image data in its componentconfig. However, if
   595  a version that is still in use gets removed from this componentconfig it cannot reconcile anymore existing <code>Worker</code>
   596  resources that are still using this version. Hence, it stores the used versions in the provider status to ensure
   597  reconciliation is possible.</p>
   598  </td>
   599  </tr>
   600  </tbody>
   601  </table>
   602  <hr/>
   603  <p><em>
   604  Generated with <a href="https://github.com/ahmetb/gen-crd-api-reference-docs">gen-crd-api-reference-docs</a>
   605  </em></p>