Skip to content

Commit

Permalink
chore: [bot] Update 'README.md'
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 11, 2023
1 parent f7efef9 commit c4407ae
Showing 1 changed file with 77 additions and 35 deletions.
112 changes: 77 additions & 35 deletions charts/t8s-cluster/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[modeline]: # ( vim: set ft=markdown: )
# t8s-cluster

![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
![Version: 3.0.0](https://img.shields.io/badge/Version-3.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

t8s-operator cluster with necessary addons

Expand All @@ -13,7 +13,7 @@ t8s-operator cluster with necessary addons
| ---- | ------ | --- |
| cwrau | <[email protected]> | |
| marvinWolff | <[email protected]> | |
| steutol | <sl@teuto.net> | |
| tasches | <st@teuto.net> | |

## Source Code

Expand All @@ -23,7 +23,7 @@ t8s-operator cluster with necessary addons

| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | common | 2.6.0 |
| https://charts.bitnami.com/bitnami | common | 2.9.1 |

## Initial installation

Expand All @@ -49,20 +49,20 @@ delete the cloud-config secret, as these will just be recreated during installat
| **Type** | `object` |
| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | -------------------- |
| - [global](#global ) | No | object | No | - | - |
| + [metadata](#metadata ) | No | object | No | - | - |
| + [controlPlane](#controlPlane ) | No | object | No | - | - |
| - [cloud](#cloud ) | No | string | No | - | - |
| + [version](#version ) | No | object | No | - | - |
| + [workers](#workers ) | No | object | No | - | - |
| - [bastion](#bastion ) | No | object | No | - | - |
| - [containerRegistryProxy](#containerRegistryProxy ) | No | object | No | - | - |
| - [sshKeyName](#sshKeyName ) | No | string or null | No | - | - |
| - [cni](#cni ) | No | enum (of string) | No | - | - |
| - [imageNameTemplate](#imageNameTemplate ) | No | object | No | - | - |
| - [common](#common ) | No | object | No | - | Values for sub-chart |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------------------------------ | ------- | ---------------- | ---------- | ---------- | -------------------- |
| - [global](#global ) | No | object | No | - | - |
| + [metadata](#metadata ) | No | object | No | - | - |
| + [controlPlane](#controlPlane ) | No | object | No | - | - |
| - [cloud](#cloud ) | No | string | No | - | - |
| + [version](#version ) | No | object | No | - | - |
| + [workers](#workers ) | No | object | No | - | - |
| - [bastion](#bastion ) | No | object | No | - | - |
| - [containerRegistryMirror](#containerRegistryMirror ) | No | object | No | - | - |
| - [sshKeyName](#sshKeyName ) | No | string or null | No | - | - |
| - [cni](#cni ) | No | enum (of string) | No | - | - |
| - [imageNameTemplate](#imageNameTemplate ) | No | object | No | - | - |
| - [common](#common ) | No | object | No | - | Values for sub-chart |

## <a name="global"></a>1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global`

Expand All @@ -76,6 +76,7 @@ delete the cloud-config secret, as these will just be recreated during installat
| - [helmRepositories](#global_helmRepositories ) | No | object | No | - | A map of helmRepositories to create, the key is the name |
| - [kubectl](#global_kubectl ) | No | object | No | - | Image with \`kubectl\` binary |
| - [etcd](#global_etcd ) | No | object | No | - | Image with \`kubectl\` binary |
| - [semver](#global_semver ) | No | object | No | - | Image with \`semver\` binary |
| - [injectedCertificateAuthorities](#global_injectedCertificateAuthorities ) | No | string | No | - | - |
| - [kubeletExtraConfig](#global_kubeletExtraConfig ) | No | object | No | - | Additional kubelet configuration |

Expand All @@ -99,10 +100,11 @@ delete the cloud-config secret, as these will just be recreated during installat
| **Type** | `object` |
| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- |
| - [url](#global_helmRepositories_additionalProperties_url ) | No | string | No | - | - |
| - [charts](#global_helmRepositories_additionalProperties_charts ) | No | object | No | - | Which charts are deployed in which version using this repo, used internally |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ----------------------------------------------------------------------- | ------- | ------ | ---------- | -------------------- | ------------------------------------------------------------------------------------------------------------ |
| - [url](#global_helmRepositories_additionalProperties_url ) | No | string | No | - | - |
| - [charts](#global_helmRepositories_additionalProperties_charts ) | No | object | No | - | Which charts are deployed in which version using this repo, used internally |
| - [condition](#global_helmRepositories_additionalProperties_condition ) | No | string | No | In #/$defs/condition | A condition with which to decide to include the resource. This will be templated. Must return a truthy value |

##### <a name="global_helmRepositories_additionalProperties_url"></a>1.1.1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > helmRepositories > additionalProperties > url`

Expand Down Expand Up @@ -133,6 +135,25 @@ delete the cloud-config secret, as these will just be recreated during installat
| -------- | -------- |
| **Type** | `string` |

##### <a name="global_helmRepositories_additionalProperties_condition"></a>1.1.1.3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > helmRepositories > additionalProperties > condition`

| | |
| -------------- | ----------------- |
| **Type** | `string` |
| **Defined in** | #/$defs/condition |

**Description:** A condition with which to decide to include the resource. This will be templated. Must return a truthy value

**Examples:**

```yaml
{{ true }}
```

```yaml
{{ eq .Values.global.baseDomain "teuto.net" }}
```

### <a name="global_kubectl"></a>1.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > kubectl`

| | |
Expand Down Expand Up @@ -222,13 +243,34 @@ bitnami/kubectl
| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
| **Same definition as** | [image](#global_kubectl_image) |

### <a name="global_injectedCertificateAuthorities"></a>1.4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > injectedCertificateAuthorities`
### <a name="global_semver"></a>1.4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > semver`

| | |
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Type** | `object` |
| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |

**Description:** Image with `semver` binary

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| -------------------------------- | ------- | ------ | ---------- | --------------------------------------- | ----------------- |
| - [image](#global_semver_image ) | No | object | No | Same as [image](#global_kubectl_image ) | - |

#### <a name="global_semver_image"></a>1.4.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > semver > image`

| | |
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Type** | `object` |
| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
| **Same definition as** | [image](#global_kubectl_image) |

### <a name="global_injectedCertificateAuthorities"></a>1.5. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > injectedCertificateAuthorities`

| | |
| -------- | -------- |
| **Type** | `string` |

### <a name="global_kubeletExtraConfig"></a>1.5. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > kubeletExtraConfig`
### <a name="global_kubeletExtraConfig"></a>1.6. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > kubeletExtraConfig`

| | |
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
Expand All @@ -241,7 +283,7 @@ bitnami/kubectl
| ---------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------ |
| - [maxParallelImagePulls](#global_kubeletExtraConfig_maxParallelImagePulls ) | No | integer | No | - | Only valid for k8s version 1.27 and later. The number of images to pull in parallel. |

#### <a name="global_kubeletExtraConfig_maxParallelImagePulls"></a>1.5.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > kubeletExtraConfig > maxParallelImagePulls`
#### <a name="global_kubeletExtraConfig_maxParallelImagePulls"></a>1.6.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > global > kubeletExtraConfig > maxParallelImagePulls`

| | |
| -------- | --------- |
Expand Down Expand Up @@ -543,19 +585,19 @@ Must be one of:
| -------- | ---------------- |
| **Type** | `null or string` |

## <a name="containerRegistryProxy"></a>8. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > containerRegistryProxy`
## <a name="containerRegistryMirror"></a>8. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > containerRegistryMirror`

| | |
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Type** | `object` |
| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ----------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
| - [additionallyProxiedRegistries](#containerRegistryProxy_additionallyProxiedRegistries ) | No | array of string | No | - | - |
| - [proxyRegistryEndpoint](#containerRegistryProxy_proxyRegistryEndpoint ) | No | string | No | - | - |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| -------------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
| - [additionallyMirroredRegistries](#containerRegistryMirror_additionallyMirroredRegistries ) | No | array of string | No | - | - |
| - [mirrorEndpoint](#containerRegistryMirror_mirrorEndpoint ) | No | string | No | - | - |

### <a name="containerRegistryProxy_additionallyProxiedRegistries"></a>8.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > containerRegistryProxy > additionallyProxiedRegistries`
### <a name="containerRegistryMirror_additionallyMirroredRegistries"></a>8.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > containerRegistryMirror > additionallyMirroredRegistries`

| | |
| -------- | ----------------- |
Expand All @@ -569,17 +611,17 @@ Must be one of:
| **Additional items** | False |
| **Tuple validation** | See below |

| Each item of this array must be | Description |
| -------------------------------------------------------------------------------------------------- | ----------- |
| [additionallyProxiedRegistries items](#containerRegistryProxy_additionallyProxiedRegistries_items) | - |
| Each item of this array must be | Description |
| ----------------------------------------------------------------------------------------------------- | ----------- |
| [additionallyMirroredRegistries items](#containerRegistryMirror_additionallyMirroredRegistries_items) | - |

#### <a name="autogenerated_heading_4"></a>8.1.1. t8s cluster configuration > containerRegistryProxy > additionallyProxiedRegistries > additionallyProxiedRegistries items
#### <a name="autogenerated_heading_4"></a>8.1.1. t8s cluster configuration > containerRegistryMirror > additionallyMirroredRegistries > additionallyMirroredRegistries items

| | |
| -------- | -------- |
| **Type** | `string` |

### <a name="containerRegistryProxy_proxyRegistryEndpoint"></a>8.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > containerRegistryProxy > proxyRegistryEndpoint`
### <a name="containerRegistryMirror_mirrorEndpoint"></a>8.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `t8s cluster configuration > containerRegistryMirror > mirrorEndpoint`

| | |
| -------- | -------- |
Expand Down

0 comments on commit c4407ae

Please sign in to comment.