diff --git a/content/master/software/install.md b/content/master/software/install.md index 33e2eb70..acfe4442 100644 --- a/content/master/software/install.md +++ b/content/master/software/install.md @@ -125,24 +125,27 @@ Apply customizations with the command line or with a Helm _values_ file. | `customAnnotations` | Add custom `annotations` to the Crossplane pod deployment. | `{}` | | `customLabels` | Add custom `labels` to the Crossplane pod deployment. | `{}` | | `deploymentStrategy` | The deployment strategy for the Crossplane and RBAC Manager pods. | `"RollingUpdate"` | +| `dnsPolicy` | Specify the `dnsPolicy` to be used by the Crossplane pod. | `""` | | `extraEnvVarsCrossplane` | Add custom environmental variables to the Crossplane pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraEnvVarsRBACManager` | Add custom environmental variables to the RBAC Manager pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` | | `extraVolumeMountsCrossplane` | Add custom `volumeMounts` 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` | +| `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. Consider setting `dnsPolicy` to `ClusterFirstWithHostNet`. | `false` | | `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` | | `image.repository` | Repository for the Crossplane pod image. | `"xpkg.crossplane.io/crossplane/crossplane"` | | `image.tag` | The Crossplane image tag. Defaults to the value of `appVersion` in `Chart.yaml`. | `""` | -| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `{}` | +| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `[]` | | `leaderElection` | Enable [leader election](https://docs.crossplane.io/latest/concepts/pods/#leader-election) for the Crossplane pod. | `true` | | `metrics.enabled` | Enable Prometheus path, port and scrape annotations and expose port 8080 for both the Crossplane and RBAC Manager pods. | `false` | +| `metrics.port` | The port the metrics server listens on. | `""` | | `nodeSelector` | Add `nodeSelectors` to the Crossplane pod deployment. | `{}` | | `packageCache.configMap` | The name of a ConfigMap to use as the package cache. Disables the default package cache `emptyDir` Volume. | `""` | | `packageCache.medium` | Set to `Memory` to hold the package cache in a RAM backed file system. Useful for Crossplane development. | `""` | | `packageCache.pvc` | The name of a PersistentVolumeClaim to use as the package cache. Disables the default package cache `emptyDir` Volume. | `""` | | `packageCache.sizeLimit` | The size limit for the package cache. If medium is `Memory` the `sizeLimit` can't exceed Node memory. | `"20Mi"` | +| `packageManager.enableAutomaticDependencyDowngrade` | Enable automatic dependency version downgrades. This configuration is only used when `--enable-dependency-version-upgrades` flag is passed. | `false` | | `podSecurityContextCrossplane` | Add a custom `securityContext` to the Crossplane pod. | `{}` | | `podSecurityContextRBACManager` | Add a custom `securityContext` to the RBAC Manager pod. | `{}` | | `priorityClassName` | The PriorityClass name to apply to the Crossplane and RBAC Manager pods. | `""` | @@ -153,20 +156,23 @@ Apply customizations with the command line or with a Helm _values_ file. | `rbacManager.leaderElection` | Enable [leader election](https://docs.crossplane.io/latest/concepts/pods/#leader-election) for the RBAC Manager pod. | `true` | | `rbacManager.nodeSelector` | Add `nodeSelectors` to the RBAC Manager pod deployment. | `{}` | | `rbacManager.replicas` | The number of RBAC Manager pod `replicas` to deploy. | `1` | +| `rbacManager.revisionHistoryLimit` | The number of RBAC Manager ReplicaSets to retain. | `nil` | | `rbacManager.skipAggregatedClusterRoles` | Don't install aggregated Crossplane ClusterRoles. | `false` | | `rbacManager.tolerations` | Add `tolerations` to the RBAC Manager pod deployment. | `[]` | | `rbacManager.topologySpreadConstraints` | Add `topologySpreadConstraints` to the RBAC Manager pod deployment. | `[]` | +| `readiness.port` | The port the readyz server listens on. | `""` | | `registryCaBundleConfig.key` | The ConfigMap key containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `registryCaBundleConfig.name` | The ConfigMap name containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `replicas` | The number of Crossplane pod `replicas` to deploy. | `1` | -| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"100m"` | -| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"512Mi"` | +| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"500m"` | +| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"1024Mi"` | | `resourcesCrossplane.requests.cpu` | CPU resource requests for the Crossplane pod. | `"100m"` | | `resourcesCrossplane.requests.memory` | Memory resource requests for the Crossplane pod. | `"256Mi"` | | `resourcesRBACManager.limits.cpu` | CPU resource limits for the RBAC Manager pod. | `"100m"` | | `resourcesRBACManager.limits.memory` | Memory resource limits for the RBAC Manager pod. | `"512Mi"` | | `resourcesRBACManager.requests.cpu` | CPU resource requests for the RBAC Manager pod. | `"100m"` | | `resourcesRBACManager.requests.memory` | Memory resource requests for the RBAC Manager pod. | `"256Mi"` | +| `revisionHistoryLimit` | The number of Crossplane ReplicaSets to retain. | `nil` | | `securityContextCrossplane.allowPrivilegeEscalation` | Enable `allowPrivilegeEscalation` for the Crossplane pod. | `false` | | `securityContextCrossplane.readOnlyRootFilesystem` | Set the Crossplane pod root file system as read-only. | `true` | | `securityContextCrossplane.runAsGroup` | The group ID used by the Crossplane pod. | `65532` | @@ -175,10 +181,14 @@ Apply customizations with the command line or with a Helm _values_ file. | `securityContextRBACManager.readOnlyRootFilesystem` | Set the RBAC Manager pod root file system as read-only. | `true` | | `securityContextRBACManager.runAsGroup` | The group ID used by the RBAC Manager pod. | `65532` | | `securityContextRBACManager.runAsUser` | The user ID used by the RBAC Manager pod. | `65532` | +| `service.customAnnotations` | Configure annotations on the service object. Only enabled when webhooks.enabled = true | `{}` | +| `serviceAccount.create` | Specifies whether Crossplane ServiceAccount should be created | `true` | | `serviceAccount.customAnnotations` | Add custom `annotations` to the Crossplane ServiceAccount. | `{}` | +| `serviceAccount.name` | Provide the name of an already created Crossplane ServiceAccount. Required when `serviceAccount.create` is `false` | `""` | | `tolerations` | Add `tolerations` to the Crossplane pod deployment. | `[]` | | `topologySpreadConstraints` | Add `topologySpreadConstraints` to the Crossplane pod deployment. | `[]` | | `webhooks.enabled` | Enable webhooks for Crossplane and installed Provider packages. | `true` | +| `webhooks.port` | The port the webhook server listens on. | `""` | {{< /table >}} {{< /expand >}} diff --git a/content/v1.17/software/install.md b/content/v1.17/software/install.md index d1cb7f02..d1f29409 100644 --- a/content/v1.17/software/install.md +++ b/content/v1.17/software/install.md @@ -38,7 +38,7 @@ helm repo update Install the Crossplane Helm chart with `helm install`. {{< hint "tip" >}} -View the changes Crossplane makes to your cluster with the +View the changes Crossplane makes to your cluster with the `helm install --dry-run --debug` options. Helm shows what configurations it applies without making changes to the Kubernetes cluster. {{< /hint >}} @@ -48,7 +48,7 @@ Crossplane creates and installs into the `crossplane-system` namespace. ```shell helm install crossplane \ --namespace crossplane-system \ ---create-namespace crossplane-stable/crossplane +--create-namespace crossplane-stable/crossplane ``` View the installed Crossplane pods with `kubectl get pods -n crossplane-system`. @@ -75,7 +75,7 @@ helm install crossplane \ ## Installed deployments Crossplane creates two Kubernetes _deployments_ in the `crossplane-system` -namespace to deploy the Crossplane pods. +namespace to deploy the Crossplane pods. ```shell {copy-lines="1"} kubectl get deployments -n crossplane-system @@ -87,10 +87,10 @@ crossplane-rbac-manager 1/1 1 1 8m13s ### Crossplane deployment The Crossplane deployment starts with the `crossplane-init container`. The `init` container installs the Crossplane _Custom Resource Definitions_ into the -Kubernetes cluster. +Kubernetes cluster. After the `init` container finishes, the `crossplane` pod manages two Kubernetes -controllers. +controllers. * The _Package Manager controller_ installs the provider, function and configuration packages. * The _Composition controller_ installs and manages the @@ -100,8 +100,8 @@ Crossplane _Composite Resource Definitions_, _Compositions_ and _Claims_. The `crossplane-rbac-manager` creates and manages Kubernetes _ClusterRoles_ for installed Crossplane _Provider_ and their _Custom Resource Definitions_. -The -[Crossplane RBAC Manager design document](https://github.com/crossplane/crossplane/blob/main/design/design-doc-rbac-manager.md) +The +[Crossplane RBAC Manager design document](https://github.com/crossplane/crossplane/blob/main/design/design-doc-rbac-manager.md) has more information on the installed _ClusterRoles_. ## Installation options @@ -110,7 +110,7 @@ has more information on the installed _ClusterRoles_. Crossplane supports customizations at install time by configuring the Helm chart. -Apply customizations with the command line or with a Helm _values_ file. +Apply customizations with the command line or with a Helm _values_ file. @@ -125,17 +125,18 @@ Apply customizations with the command line or with a Helm _values_ file. | `customAnnotations` | Add custom `annotations` to the Crossplane pod deployment. | `{}` | | `customLabels` | Add custom `labels` to the Crossplane pod deployment. | `{}` | | `deploymentStrategy` | The deployment strategy for the Crossplane and RBAC Manager pods. | `"RollingUpdate"` | +| `dnsPolicy` | Specify the `dnsPolicy` to be used by the Crossplane pod. | `""` | | `extraEnvVarsCrossplane` | Add custom environmental variables to the Crossplane pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraEnvVarsRBACManager` | Add custom environmental variables to the RBAC Manager pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` | | `extraVolumeMountsCrossplane` | Add custom `volumeMounts` 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` | +| `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. Consider setting `dnsPolicy` to `ClusterFirstWithHostNet`. | `false` | | `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` | | `image.repository` | Repository for the Crossplane pod image. | `"xpkg.crossplane.io/crossplane/crossplane"` | | `image.tag` | The Crossplane image tag. Defaults to the value of `appVersion` in `Chart.yaml`. | `""` | -| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `{}` | +| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `[]` | | `leaderElection` | Enable [leader election](https://docs.crossplane.io/latest/concepts/pods/#leader-election) for the Crossplane pod. | `true` | | `metrics.enabled` | Enable Prometheus path, port and scrape annotations and expose port 8080 for both the Crossplane and RBAC Manager pods. | `false` | | `nodeSelector` | Add `nodeSelectors` to the Crossplane pod deployment. | `{}` | @@ -159,8 +160,8 @@ Apply customizations with the command line or with a Helm _values_ file. | `registryCaBundleConfig.key` | The ConfigMap key containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `registryCaBundleConfig.name` | The ConfigMap name containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `replicas` | The number of Crossplane pod `replicas` to deploy. | `1` | -| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"100m"` | -| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"512Mi"` | +| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"500m"` | +| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"1024Mi"` | | `resourcesCrossplane.requests.cpu` | CPU resource requests for the Crossplane pod. | `"100m"` | | `resourcesCrossplane.requests.memory` | Memory resource requests for the Crossplane pod. | `"256Mi"` | | `resourcesRBACManager.limits.cpu` | CPU resource limits for the RBAC Manager pod. | `"100m"` | @@ -175,6 +176,7 @@ Apply customizations with the command line or with a Helm _values_ file. | `securityContextRBACManager.readOnlyRootFilesystem` | Set the RBAC Manager pod root file system as read-only. | `true` | | `securityContextRBACManager.runAsGroup` | The group ID used by the RBAC Manager pod. | `65532` | | `securityContextRBACManager.runAsUser` | The user ID used by the RBAC Manager pod. | `65532` | +| `service.customAnnotations` | Configure annotations on the service object. Only enabled when webhooks.enabled = true | `{}` | | `serviceAccount.customAnnotations` | Add custom `annotations` to the Crossplane ServiceAccount. | `{}` | | `tolerations` | Add `tolerations` to the Crossplane pod deployment. | `[]` | | `topologySpreadConstraints` | Add `topologySpreadConstraints` to the Crossplane pod deployment. | `[]` | @@ -185,7 +187,7 @@ Apply customizations with the command line or with a Helm _values_ file. #### Command line customization -Apply custom settings at the command line with +Apply custom settings at the command line with `helm install crossplane --set =`. For example, to change the image pull policy: @@ -215,7 +217,7 @@ crossplane-stable/crossplane \ Apply custom settings in a Helm _values_ file with `helm install crossplane -f `. -A YAML file defines the customized settings. +A YAML file defines the customized settings. For example, to change the image pull policy and number of replicas: @@ -241,9 +243,9 @@ crossplane-stable/crossplane \ #### Feature flags Crossplane introduces new features behind feature flags. By default -alpha features are off. Crossplane enables beta features by default. To enable a +alpha features are off. Crossplane enables beta features by default. To enable a feature flag, set the `args` value in the Helm chart. Available feature flags -can be directly found by running `crossplane core start --help`, or by looking +can be directly found by running `crossplane core start --help`, or by looking at the table below. {{< expand "Feature flags" >}} @@ -266,10 +268,12 @@ args='{"--enable-composition-functions","--enable-composition-webhook-schema-val #### Change the default package registry -Beginning with Crossplane version 1.20.0 Crossplane uses the [crossplane-contrib](https://github.com/orgs/crossplane-contrib/packages) GitHub Container Registry at `xpkg.crossplane.io` by default for downloading and -installing packages. +Beginning with Crossplane version 1.20.0 Crossplane uses the +[crossplane-contrib](https://github.com/orgs/crossplane-contrib/packages) GitHub +Container Registry at `xpkg.crossplane.io` by default for downloading and +installing packages. -Change the default registry location during the Crossplane install with +Change the default registry location during the Crossplane install with `--set args='{"--registry=index.docker.io"}'`. ### Install pre-release Crossplane versions @@ -278,7 +282,7 @@ Install a pre-release versions of Crossplane from the `master` Crossplane Helm c Versions in the `master` channel are under active development and may be unstable. {{< hint "warning" >}} -Don't use Crossplane `master` releases in production. Only use `stable` channel. +Don't use Crossplane `master` releases in production. Only use `stable` channel. Only use `master` for testing and development. {{< /hint >}} @@ -302,7 +306,7 @@ helm repo update Install the Crossplane `master` Helm chart with `helm install`. {{< hint "tip" >}} -View the changes Crossplane makes to your cluster with the +View the changes Crossplane makes to your cluster with the `helm install --dry-run --debug` options. Helm shows what configurations it applies without making changes to the Kubernetes cluster. {{< /hint >}} @@ -313,14 +317,14 @@ Crossplane creates and installs into the `crossplane-system` namespace. helm install crossplane \ --namespace crossplane-system \ --create-namespace crossplane-master/crossplane \ ---devel +--devel ``` ## Crossplane distributions Third-party vendors may maintain their own Crossplane distributions. Vendor supported distribution may have features or tooling that isn't in the -Community Crossplane distribution. +Community Crossplane distribution. -The CNCF certified third-party distributions as -"[conformant](https://github.com/cncf/crossplane-conformance)" with the +The CNCF certified third-party distributions as +"[conformant](https://github.com/cncf/crossplane-conformance)" with the Community Crossplane distribution. \ No newline at end of file diff --git a/content/v1.18/software/install.md b/content/v1.18/software/install.md index feeadda4..e88454ab 100644 --- a/content/v1.18/software/install.md +++ b/content/v1.18/software/install.md @@ -38,7 +38,7 @@ helm repo update Install the Crossplane Helm chart with `helm install`. {{< hint "tip" >}} -View the changes Crossplane makes to your cluster with the +View the changes Crossplane makes to your cluster with the `helm install --dry-run --debug` options. Helm shows what configurations it applies without making changes to the Kubernetes cluster. {{< /hint >}} @@ -48,7 +48,7 @@ Crossplane creates and installs into the `crossplane-system` namespace. ```shell helm install crossplane \ --namespace crossplane-system \ ---create-namespace crossplane-stable/crossplane +--create-namespace crossplane-stable/crossplane ``` View the installed Crossplane pods with `kubectl get pods -n crossplane-system`. @@ -75,7 +75,7 @@ helm install crossplane \ ## Installed deployments Crossplane creates two Kubernetes _deployments_ in the `crossplane-system` -namespace to deploy the Crossplane pods. +namespace to deploy the Crossplane pods. ```shell {copy-lines="1"} kubectl get deployments -n crossplane-system @@ -87,10 +87,10 @@ crossplane-rbac-manager 1/1 1 1 8m13s ### Crossplane deployment The Crossplane deployment starts with the `crossplane-init container`. The `init` container installs the Crossplane _Custom Resource Definitions_ into the -Kubernetes cluster. +Kubernetes cluster. After the `init` container finishes, the `crossplane` pod manages two Kubernetes -controllers. +controllers. * The _Package Manager controller_ installs the provider, function and configuration packages. * The _Composition controller_ installs and manages the @@ -100,8 +100,8 @@ Crossplane _Composite Resource Definitions_, _Compositions_ and _Claims_. The `crossplane-rbac-manager` creates and manages Kubernetes _ClusterRoles_ for installed Crossplane _Provider_ and their _Custom Resource Definitions_. -The -[Crossplane RBAC Manager design document](https://github.com/crossplane/crossplane/blob/main/design/design-doc-rbac-manager.md) +The +[Crossplane RBAC Manager design document](https://github.com/crossplane/crossplane/blob/main/design/design-doc-rbac-manager.md) has more information on the installed _ClusterRoles_. ## Installation options @@ -110,7 +110,7 @@ has more information on the installed _ClusterRoles_. Crossplane supports customizations at install time by configuring the Helm chart. -Apply customizations with the command line or with a Helm _values_ file. +Apply customizations with the command line or with a Helm _values_ file. @@ -125,17 +125,18 @@ Apply customizations with the command line or with a Helm _values_ file. | `customAnnotations` | Add custom `annotations` to the Crossplane pod deployment. | `{}` | | `customLabels` | Add custom `labels` to the Crossplane pod deployment. | `{}` | | `deploymentStrategy` | The deployment strategy for the Crossplane and RBAC Manager pods. | `"RollingUpdate"` | +| `dnsPolicy` | Specify the `dnsPolicy` to be used by the Crossplane pod. | `""` | | `extraEnvVarsCrossplane` | Add custom environmental variables to the Crossplane pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraEnvVarsRBACManager` | Add custom environmental variables to the RBAC Manager pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` | | `extraVolumeMountsCrossplane` | Add custom `volumeMounts` 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` | +| `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. Consider setting `dnsPolicy` to `ClusterFirstWithHostNet`. | `false` | | `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` | | `image.repository` | Repository for the Crossplane pod image. | `"xpkg.crossplane.io/crossplane/crossplane"` | | `image.tag` | The Crossplane image tag. Defaults to the value of `appVersion` in `Chart.yaml`. | `""` | -| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `{}` | +| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `[]` | | `leaderElection` | Enable [leader election](https://docs.crossplane.io/latest/concepts/pods/#leader-election) for the Crossplane pod. | `true` | | `metrics.enabled` | Enable Prometheus path, port and scrape annotations and expose port 8080 for both the Crossplane and RBAC Manager pods. | `false` | | `nodeSelector` | Add `nodeSelectors` to the Crossplane pod deployment. | `{}` | @@ -153,20 +154,22 @@ Apply customizations with the command line or with a Helm _values_ file. | `rbacManager.leaderElection` | Enable [leader election](https://docs.crossplane.io/latest/concepts/pods/#leader-election) for the RBAC Manager pod. | `true` | | `rbacManager.nodeSelector` | Add `nodeSelectors` to the RBAC Manager pod deployment. | `{}` | | `rbacManager.replicas` | The number of RBAC Manager pod `replicas` to deploy. | `1` | +| `rbacManager.revisionHistoryLimit` | The number of RBAC Manager ReplicaSets to retain. | `nil` | | `rbacManager.skipAggregatedClusterRoles` | Don't install aggregated Crossplane ClusterRoles. | `false` | | `rbacManager.tolerations` | Add `tolerations` to the RBAC Manager pod deployment. | `[]` | | `rbacManager.topologySpreadConstraints` | Add `topologySpreadConstraints` to the RBAC Manager pod deployment. | `[]` | | `registryCaBundleConfig.key` | The ConfigMap key containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `registryCaBundleConfig.name` | The ConfigMap name containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `replicas` | The number of Crossplane pod `replicas` to deploy. | `1` | -| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"100m"` | -| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"512Mi"` | +| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"500m"` | +| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"1024Mi"` | | `resourcesCrossplane.requests.cpu` | CPU resource requests for the Crossplane pod. | `"100m"` | | `resourcesCrossplane.requests.memory` | Memory resource requests for the Crossplane pod. | `"256Mi"` | | `resourcesRBACManager.limits.cpu` | CPU resource limits for the RBAC Manager pod. | `"100m"` | | `resourcesRBACManager.limits.memory` | Memory resource limits for the RBAC Manager pod. | `"512Mi"` | | `resourcesRBACManager.requests.cpu` | CPU resource requests for the RBAC Manager pod. | `"100m"` | | `resourcesRBACManager.requests.memory` | Memory resource requests for the RBAC Manager pod. | `"256Mi"` | +| `revisionHistoryLimit` | The number of Crossplane ReplicaSets to retain. | `nil` | | `securityContextCrossplane.allowPrivilegeEscalation` | Enable `allowPrivilegeEscalation` for the Crossplane pod. | `false` | | `securityContextCrossplane.readOnlyRootFilesystem` | Set the Crossplane pod root file system as read-only. | `true` | | `securityContextCrossplane.runAsGroup` | The group ID used by the Crossplane pod. | `65532` | @@ -175,6 +178,7 @@ Apply customizations with the command line or with a Helm _values_ file. | `securityContextRBACManager.readOnlyRootFilesystem` | Set the RBAC Manager pod root file system as read-only. | `true` | | `securityContextRBACManager.runAsGroup` | The group ID used by the RBAC Manager pod. | `65532` | | `securityContextRBACManager.runAsUser` | The user ID used by the RBAC Manager pod. | `65532` | +| `service.customAnnotations` | Configure annotations on the service object. Only enabled when webhooks.enabled = true | `{}` | | `serviceAccount.customAnnotations` | Add custom `annotations` to the Crossplane ServiceAccount. | `{}` | | `tolerations` | Add `tolerations` to the Crossplane pod deployment. | `[]` | | `topologySpreadConstraints` | Add `topologySpreadConstraints` to the Crossplane pod deployment. | `[]` | @@ -185,7 +189,7 @@ Apply customizations with the command line or with a Helm _values_ file. #### Command line customization -Apply custom settings at the command line with +Apply custom settings at the command line with `helm install crossplane --set =`. For example, to change the image pull policy: @@ -215,7 +219,7 @@ crossplane-stable/crossplane \ Apply custom settings in a Helm _values_ file with `helm install crossplane -f `. -A YAML file defines the customized settings. +A YAML file defines the customized settings. For example, to change the image pull policy and number of replicas: @@ -241,9 +245,9 @@ crossplane-stable/crossplane \ #### Feature flags Crossplane introduces new features behind feature flags. By default -alpha features are off. Crossplane enables beta features by default. To enable a +alpha features are off. Crossplane enables beta features by default. To enable a feature flag, set the `args` value in the Helm chart. Available feature flags -can be directly found by running `crossplane core start --help`, or by looking +can be directly found by running `crossplane core start --help`, or by looking at the table below. {{< expand "Feature flags" >}} @@ -267,10 +271,12 @@ args='{"--enable-composition-functions","--enable-composition-webhook-schema-val #### Change the default package registry -Beginning with Crossplane version 1.20.0 Crossplane uses the [crossplane-contrib](https://github.com/orgs/crossplane-contrib/packages) GitHub Container Registry at `xpkg.crossplane.io` by default for downloading and -installing packages. +Beginning with Crossplane version 1.20.0 Crossplane uses the +[crossplane-contrib](https://github.com/orgs/crossplane-contrib/packages) GitHub +Container Registry at `xpkg.crossplane.io` by default for downloading and +installing packages. -Change the default registry location during the Crossplane install with +Change the default registry location during the Crossplane install with `--set args='{"--registry=index.docker.io"}'`. ### Install pre-release Crossplane versions @@ -279,7 +285,7 @@ Install a pre-release versions of Crossplane from the `master` Crossplane Helm c Versions in the `master` channel are under active development and may be unstable. {{< hint "warning" >}} -Don't use Crossplane `master` releases in production. Only use `stable` channel. +Don't use Crossplane `master` releases in production. Only use `stable` channel. Only use `master` for testing and development. {{< /hint >}} @@ -303,7 +309,7 @@ helm repo update Install the Crossplane `master` Helm chart with `helm install`. {{< hint "tip" >}} -View the changes Crossplane makes to your cluster with the +View the changes Crossplane makes to your cluster with the `helm install --dry-run --debug` options. Helm shows what configurations it applies without making changes to the Kubernetes cluster. {{< /hint >}} @@ -314,14 +320,14 @@ Crossplane creates and installs into the `crossplane-system` namespace. helm install crossplane \ --namespace crossplane-system \ --create-namespace crossplane-master/crossplane \ ---devel +--devel ``` ## Crossplane distributions Third-party vendors may maintain their own Crossplane distributions. Vendor supported distribution may have features or tooling that isn't in the -Community Crossplane distribution. +Community Crossplane distribution. -The CNCF certified third-party distributions as -"[conformant](https://github.com/cncf/crossplane-conformance)" with the +The CNCF certified third-party distributions as +"[conformant](https://github.com/cncf/crossplane-conformance)" with the Community Crossplane distribution. \ No newline at end of file diff --git a/content/v1.19/software/install.md b/content/v1.19/software/install.md index 33e2eb70..acfe4442 100644 --- a/content/v1.19/software/install.md +++ b/content/v1.19/software/install.md @@ -125,24 +125,27 @@ Apply customizations with the command line or with a Helm _values_ file. | `customAnnotations` | Add custom `annotations` to the Crossplane pod deployment. | `{}` | | `customLabels` | Add custom `labels` to the Crossplane pod deployment. | `{}` | | `deploymentStrategy` | The deployment strategy for the Crossplane and RBAC Manager pods. | `"RollingUpdate"` | +| `dnsPolicy` | Specify the `dnsPolicy` to be used by the Crossplane pod. | `""` | | `extraEnvVarsCrossplane` | Add custom environmental variables to the Crossplane pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraEnvVarsRBACManager` | Add custom environmental variables to the RBAC Manager pod deployment. Replaces any `.` in a variable name with `_`. For example, `SAMPLE.KEY=value1` becomes `SAMPLE_KEY=value1`. | `{}` | | `extraObjects` | To add arbitrary Kubernetes Objects during a Helm Install | `[]` | | `extraVolumeMountsCrossplane` | Add custom `volumeMounts` 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` | +| `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. Consider setting `dnsPolicy` to `ClusterFirstWithHostNet`. | `false` | | `image.pullPolicy` | The image pull policy used for Crossplane and RBAC Manager pods. | `"IfNotPresent"` | | `image.repository` | Repository for the Crossplane pod image. | `"xpkg.crossplane.io/crossplane/crossplane"` | | `image.tag` | The Crossplane image tag. Defaults to the value of `appVersion` in `Chart.yaml`. | `""` | -| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `{}` | +| `imagePullSecrets` | The imagePullSecret names to add to the Crossplane ServiceAccount. | `[]` | | `leaderElection` | Enable [leader election](https://docs.crossplane.io/latest/concepts/pods/#leader-election) for the Crossplane pod. | `true` | | `metrics.enabled` | Enable Prometheus path, port and scrape annotations and expose port 8080 for both the Crossplane and RBAC Manager pods. | `false` | +| `metrics.port` | The port the metrics server listens on. | `""` | | `nodeSelector` | Add `nodeSelectors` to the Crossplane pod deployment. | `{}` | | `packageCache.configMap` | The name of a ConfigMap to use as the package cache. Disables the default package cache `emptyDir` Volume. | `""` | | `packageCache.medium` | Set to `Memory` to hold the package cache in a RAM backed file system. Useful for Crossplane development. | `""` | | `packageCache.pvc` | The name of a PersistentVolumeClaim to use as the package cache. Disables the default package cache `emptyDir` Volume. | `""` | | `packageCache.sizeLimit` | The size limit for the package cache. If medium is `Memory` the `sizeLimit` can't exceed Node memory. | `"20Mi"` | +| `packageManager.enableAutomaticDependencyDowngrade` | Enable automatic dependency version downgrades. This configuration is only used when `--enable-dependency-version-upgrades` flag is passed. | `false` | | `podSecurityContextCrossplane` | Add a custom `securityContext` to the Crossplane pod. | `{}` | | `podSecurityContextRBACManager` | Add a custom `securityContext` to the RBAC Manager pod. | `{}` | | `priorityClassName` | The PriorityClass name to apply to the Crossplane and RBAC Manager pods. | `""` | @@ -153,20 +156,23 @@ Apply customizations with the command line or with a Helm _values_ file. | `rbacManager.leaderElection` | Enable [leader election](https://docs.crossplane.io/latest/concepts/pods/#leader-election) for the RBAC Manager pod. | `true` | | `rbacManager.nodeSelector` | Add `nodeSelectors` to the RBAC Manager pod deployment. | `{}` | | `rbacManager.replicas` | The number of RBAC Manager pod `replicas` to deploy. | `1` | +| `rbacManager.revisionHistoryLimit` | The number of RBAC Manager ReplicaSets to retain. | `nil` | | `rbacManager.skipAggregatedClusterRoles` | Don't install aggregated Crossplane ClusterRoles. | `false` | | `rbacManager.tolerations` | Add `tolerations` to the RBAC Manager pod deployment. | `[]` | | `rbacManager.topologySpreadConstraints` | Add `topologySpreadConstraints` to the RBAC Manager pod deployment. | `[]` | +| `readiness.port` | The port the readyz server listens on. | `""` | | `registryCaBundleConfig.key` | The ConfigMap key containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `registryCaBundleConfig.name` | The ConfigMap name containing a custom CA bundle to enable fetching packages from registries with unknown or untrusted certificates. | `""` | | `replicas` | The number of Crossplane pod `replicas` to deploy. | `1` | -| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"100m"` | -| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"512Mi"` | +| `resourcesCrossplane.limits.cpu` | CPU resource limits for the Crossplane pod. | `"500m"` | +| `resourcesCrossplane.limits.memory` | Memory resource limits for the Crossplane pod. | `"1024Mi"` | | `resourcesCrossplane.requests.cpu` | CPU resource requests for the Crossplane pod. | `"100m"` | | `resourcesCrossplane.requests.memory` | Memory resource requests for the Crossplane pod. | `"256Mi"` | | `resourcesRBACManager.limits.cpu` | CPU resource limits for the RBAC Manager pod. | `"100m"` | | `resourcesRBACManager.limits.memory` | Memory resource limits for the RBAC Manager pod. | `"512Mi"` | | `resourcesRBACManager.requests.cpu` | CPU resource requests for the RBAC Manager pod. | `"100m"` | | `resourcesRBACManager.requests.memory` | Memory resource requests for the RBAC Manager pod. | `"256Mi"` | +| `revisionHistoryLimit` | The number of Crossplane ReplicaSets to retain. | `nil` | | `securityContextCrossplane.allowPrivilegeEscalation` | Enable `allowPrivilegeEscalation` for the Crossplane pod. | `false` | | `securityContextCrossplane.readOnlyRootFilesystem` | Set the Crossplane pod root file system as read-only. | `true` | | `securityContextCrossplane.runAsGroup` | The group ID used by the Crossplane pod. | `65532` | @@ -175,10 +181,14 @@ Apply customizations with the command line or with a Helm _values_ file. | `securityContextRBACManager.readOnlyRootFilesystem` | Set the RBAC Manager pod root file system as read-only. | `true` | | `securityContextRBACManager.runAsGroup` | The group ID used by the RBAC Manager pod. | `65532` | | `securityContextRBACManager.runAsUser` | The user ID used by the RBAC Manager pod. | `65532` | +| `service.customAnnotations` | Configure annotations on the service object. Only enabled when webhooks.enabled = true | `{}` | +| `serviceAccount.create` | Specifies whether Crossplane ServiceAccount should be created | `true` | | `serviceAccount.customAnnotations` | Add custom `annotations` to the Crossplane ServiceAccount. | `{}` | +| `serviceAccount.name` | Provide the name of an already created Crossplane ServiceAccount. Required when `serviceAccount.create` is `false` | `""` | | `tolerations` | Add `tolerations` to the Crossplane pod deployment. | `[]` | | `topologySpreadConstraints` | Add `topologySpreadConstraints` to the Crossplane pod deployment. | `[]` | | `webhooks.enabled` | Enable webhooks for Crossplane and installed Provider packages. | `true` | +| `webhooks.port` | The port the webhook server listens on. | `""` | {{< /table >}} {{< /expand >}} diff --git a/utils/vale/styles/Crossplane/allowed-jargon.txt b/utils/vale/styles/Crossplane/allowed-jargon.txt index dc549170..fe830288 100644 --- a/utils/vale/styles/Crossplane/allowed-jargon.txt +++ b/utils/vale/styles/Crossplane/allowed-jargon.txt @@ -66,6 +66,8 @@ proselint protobuf QPS RBAC +readyz +ReplicaSets RPC RPCs RSS @@ -93,4 +95,5 @@ TLS tolerations UI VM +webhooks.enabled YAML \ No newline at end of file