Files
chart/library/common/docs/scaleExternalInterface.md
Stavros Kois 63326effb3 NAS-121481 / 23.10 / Set nvidia caps to void when no gpu is passed, also adds render group when a gpu is selected and other small fixes (#1124)
* Set nvidia caps to void when no gpu is passed

* add tests to init containers too

* Additionally add `render` group when gpu is added

* Correctly handle "0" gpu

* handle fsGroup 0 properly

* fix gh highlight

* Correct nvidia variable and add additional check for runtime

* cast both sides of the comparison

* fix externalinterfaces nesting

* Add dnsConfig missing docs
2023-04-20 01:27:23 +03:00

48 lines
3.4 KiB
Markdown

# Scale External Interface
| Key | Type | Required | Helm Template | Default | Description |
| :----------------------------------------------------- | :-------: | :-----------------------------: | :-----------: | :-----: | :------------------------------------------------------------------------------ |
| scaleExternalInterface | `list` | ❌ | ❌ | `[]` | Define the external interfaces as list |
| scaleExternalInterface.targetSelectAll | `boolean` | ❌ | ❌ | `false` | Whether to add the annotation for this external interface to all workloads |
| scaleExternalInterface.targetSelector | `list` | ❌ | ❌ | `[]` | Which workloads to add the annotations |
| scaleExternalInterface.hostInterface | `string` | ✅ | ❌ | `""` | Define the hostInterface, (options in GUI populated from Middleware references) |
| scaleExternalInterface.ipam | `dict` | ✅ | ❌ | `{}` | Define the ipam |
| scaleExternalInterface.ipam.type | `string` | ✅ | ❌ | `""` | Define the ipam type (dchp, static) |
| scaleExternalInterface.ipam.staticIPConfiguration | `list` | ✅ (Only when static ipam type) | ❌ | `[]` | Define static IP Configuration (Only with static ipam type) |
| scaleExternalInterface.ipam.staticIPConfiguration.[IP] | `string` | ✅ | ❌ | `""` | Define the static IP (Only with static ipam type) |
| scaleExternalInterface.ipam.staticRoutes | `list` | ❌ | ❌ | `[]` | Define static routes (Only with static ipam type) |
| scaleExternalInterface.ipam.staticRoutes.destination | `string` | ✅ | ❌ | `""` | Define the static destination (Only with static ipam type) |
| scaleExternalInterface.ipam.staticRoutes.gateway | `string` | ✅ | ❌ | `""` | Define the static gateway (Only with static ipam type) |
> When `targetSelectAll` is `true`, it will add the annotations to all pods (`targetSelector` is ignored in this case)
> When `targetSelector` is a list, each entry is a string, with the pod name that will add the annotations. Can have multiple entries.
> When `targetSelector` is a empty, it will add the annotations to the primary pod
---
Appears in:
- `.Values.scaleExternalInterface`
---
Naming scheme:
- `ix-$ReleaseName-$index` (ix-release-name-0)
---
Examples:
```yaml
scaleExternalInterface:
- hostInterface: ""
ipam:
type: ""
staticRoutes: []
staticIPConfigurations: []
# targetSelectAll: false
targetSelector:
- workload-name
```