Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions docs/user/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ The following `install-config.yaml` properties are available:
* `additionalTrustBundle` (optional string): a PEM-encoded X.509 certificate bundle that will be added to the nodes' trusted certificate store.
This trust bundle may also be used when [a proxy has been configured](#proxy).
* `baseDomain` (required string): The base domain to which the cluster should belong.
* `publish` (optional string): This controls how the user facing endpoints of the cluster like the Kubernetes API, OpenShift routes etc. are exposed.
Valid values are `External` (the default) and `Internal`.
* `capabilities` (optional [capabilities](#capabilities)): Capabilities configures the installation of optional core cluster components.
* `controlPlane` (optional [machine-pool](#machine-pools)): The configuration for the machines that comprise the control plane.
* `compute` (optional array of [machine-pools](#machine-pools)): The configuration for the machines that comprise the compute nodes.
* `fips` (optional boolean): Enables FIPS mode (default false).
Expand Down Expand Up @@ -60,9 +59,15 @@ The following `install-config.yaml` properties are available:
* `httpProxy` (optional string): The URL of the proxy for HTTP requests.
* `httpsProxy` (optional string): The URL of the proxy for HTTPS requests.
* `noProxy` (optional string): A comma-separated list of domains and [CIDRs][cidr-notation] for which the proxy should not be used.
* `publish` (optional string): This controls how the user facing endpoints of the cluster like the Kubernetes API, OpenShift routes etc. are exposed.
Valid values are `External` (the default) and `Internal`.
* `pullSecret` (required string): The secret to use when pulling images.
* `sshKey` (optional string): The public Secure Shell (SSH) key to provide access to instances.

### Capabilities

* `baselineCapabilitySet` (optional string): Selects an initial set of optional capabilities to enable. The default value is `vCurrent` (the default). Aadditional valid values can be found [here](https://pkg.go.dev/github.com/openshift/api/config/v1#ClusterVersionCapabilitySet).
* `additionalEnabledCapabilities` (optional array of strings): Extends the set of managed capabilities beyond the baseline defined in `baselineCapabilitySet`. Default is an empty set. Valid values can be found [here](https://pkg.go.dev/github.com/openshift/api/config/v1#ClusterVersionCapability).
### IP networks

IP networks are represented as strings using [Classless Inter-Domain Routing (CIDR) notation][cidr-notation] with a traditional IP address or network number, followed by the "/" (slash) character, followed by a decimal value between 0 and 32 that describes the number of significant bits.
Expand Down Expand Up @@ -110,6 +115,23 @@ pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...
```

### Custom capabilities

An example install config where the user can specify a custom list of capabilities than a default set deployed by the installer. In this example, the user requested to use `None`, an empty set, as the baseline capability set but specified that the `openshift-samples` to be installed.

```yaml
apiVersion: v1
baseDomain: example.com
metadata:
name: test-cluster
platform: ...
capabilities:
baselineCapabilitySet: None
additionalEnabledCapabilities:
- openshift-samples
sshKey: ...
```

### Custom machine pools

An example install config with custom machine pools to grow the size of the worker pool and disable hyperthreading:
Expand Down