Add documentation for function deployment via Crossplane Helm Chart (#756)

Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>
This commit is contained in:
Bob Haddleton 2024-04-16 15:25:11 -05:00 committed by GitHub
parent 138f816642
commit 3e9e10671c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 8 additions and 2 deletions

View File

@ -66,6 +66,8 @@ extraEnvVarsRBACManager: {}
extraObjects: [] extraObjects: []
extraVolumeMountsCrossplane: {} extraVolumeMountsCrossplane: {}
extraVolumesCrossplane: {} extraVolumesCrossplane: {}
function:
packages: []
hostNetwork: false hostNetwork: false
image: image:
pullPolicy: IfNotPresent pullPolicy: IfNotPresent

View File

@ -92,7 +92,7 @@ Kubernetes cluster.
After the `init` container finishes, the `crossplane` pod manages two Kubernetes After the `init` container finishes, the `crossplane` pod manages two Kubernetes
controllers. controllers.
* The _Package Manager controller_ installs the * The _Package Manager controller_ installs the
provider and configuration packages. provider, function and configuration packages.
* The _Composition controller_ installs and manages the * The _Composition controller_ installs and manages the
Crossplane _Composite Resource Definitions_, _Compositions_ and _Claims_. Crossplane _Composite Resource Definitions_, _Compositions_ and _Claims_.
@ -130,6 +130,7 @@ Apply customizations with the command line or with a Helm _values_ file.
| `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` | | `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` |
| `extraVolumeMountsCrossplane` | Add custom `volumeMounts` to the Crossplane pod. | `{}` | | `extraVolumeMountsCrossplane` | Add custom `volumeMounts` to the Crossplane pod. | `{}` |
| `extraVolumesCrossplane` | Add custom `volumes` to the Crossplane pod. | `{}` | | `extraVolumesCrossplane` | Add custom `volumes` to the Crossplane pod. | `{}` |
| `function.packages` | A list of Function packages to install. | `[]` |
| `hostNetwork` | Enable `hostNetwork` for the Crossplane deployment. Caution: enabling `hostNetwork` grants the Crossplane Pod access to the host network namespace. | `false` | | `hostNetwork` | Enable `hostNetwork` for the Crossplane deployment. Caution: enabling `hostNetwork` grants the Crossplane Pod access to the host network namespace. | `false` |
| `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` | | `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` |
| `image.repository` | Repository for the Crossplane pod image. | `"xpkg.upbound.io/crossplane/crossplane"` | | `image.repository` | Repository for the Crossplane pod image. | `"xpkg.upbound.io/crossplane/crossplane"` |

View File

@ -66,6 +66,8 @@ extraEnvVarsRBACManager: {}
extraObjects: [] extraObjects: []
extraVolumeMountsCrossplane: {} extraVolumeMountsCrossplane: {}
extraVolumesCrossplane: {} extraVolumesCrossplane: {}
function:
packages: []
hostNetwork: false hostNetwork: false
image: image:
pullPolicy: IfNotPresent pullPolicy: IfNotPresent

View File

@ -92,7 +92,7 @@ Kubernetes cluster.
After the `init` container finishes, the `crossplane` pod manages two Kubernetes After the `init` container finishes, the `crossplane` pod manages two Kubernetes
controllers. controllers.
* The _Package Manager controller_ installs the * The _Package Manager controller_ installs the
provider and configuration packages. provider, function and configuration packages.
* The _Composition controller_ installs and manages the * The _Composition controller_ installs and manages the
Crossplane _Composite Resource Definitions_, _Compositions_ and _Claims_. Crossplane _Composite Resource Definitions_, _Compositions_ and _Claims_.
@ -130,6 +130,7 @@ Apply customizations with the command line or with a Helm _values_ file.
| `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` | | `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` |
| `extraVolumeMountsCrossplane` | Add custom `volumeMounts` to the Crossplane pod. | `{}` | | `extraVolumeMountsCrossplane` | Add custom `volumeMounts` to the Crossplane pod. | `{}` |
| `extraVolumesCrossplane` | Add custom `volumes` to the Crossplane pod. | `{}` | | `extraVolumesCrossplane` | Add custom `volumes` to the Crossplane pod. | `{}` |
| `function.packages` | A list of Function packages to install. | `[]` |
| `hostNetwork` | Enable `hostNetwork` for the Crossplane deployment. Caution: enabling `hostNetwork` grants the Crossplane Pod access to the host network namespace. | `false` | | `hostNetwork` | Enable `hostNetwork` for the Crossplane deployment. Caution: enabling `hostNetwork` grants the Crossplane Pod access to the host network namespace. | `false` |
| `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` | | `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` |
| `image.repository` | Repository for the Crossplane pod image. | `"xpkg.upbound.io/crossplane/crossplane"` | | `image.repository` | Repository for the Crossplane pod image. | `"xpkg.upbound.io/crossplane/crossplane"` |