Skip to content

Latest commit

 

History

History
138 lines (132 loc) · 5.8 KB

installation-azure-config-yaml.adoc

File metadata and controls

138 lines (132 loc) · 5.8 KB

Sample customized install-config.yaml file for Azure

You can customize the install-config.yaml file to specify more details about your {product-title} cluster’s platform or modify the values of the required parameters.

Important

This sample YAML file is provided for reference only. You must obtain your install-config.yaml file by using the installation program and modify it.

 
apiVersion: v1
baseDomain: example.com (1)
controlPlane: (2)
  hyperthreading: Enabled (3) (4)
  name: master
  platform:
    azure:
      osDisk:
        diskSizeGB: 512 (5)
      type: Standard_D8s_v3
  replicas: 3
compute: (2)
- hyperthreading: Enabled (3)
  name: worker
  platform:
    azure:
      type: Standard_D2s_v3
      osDisk:
        diskSizeGB: 512 (5)
      zones: (6)
      - "1"
      - "2"
      - "3"
  replicas: 5
metadata:
  name: test-cluster (1)
networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23
  machineCIDR: 10.0.0.0/16
  networkType: OpenShiftSDN
  serviceNetwork:
  - 172.30.0.0/16
platform:
  azure:
    region: centralus (1)
    baseDomainResourceGroupName: resource_group (7)
pullSecret: '{"auths": ...}' (1)
fips: false (8)
sshKey: ssh-ed25519 AAAA... (9)

  1. Required. The installation program prompts you for this value.

  2. If you do not provide these parameters and values, the installation program provides the default value.

  3. The controlPlane section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the compute section must begin with a hyphen, -, and the first line of the controlPlane section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.

  4. Whether to enable or disable simultaneous multithreading, or hyperthreading. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to Disabled. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines.

    Important

    If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. Use larger virtual machine types, such as Standard_D8s_v3, for your machines if you disable simultaneous multithreading.

  5. You can specify the size of the disk to use in GB.

  6. Specify a list of zones to deploy your machines to. For high availability, specify at least two zones.

  7. Specify the name of the resource group that contains the DNS zone for your base domain.

  8. Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.

  9. You can optionally provide the sshKey value that you use to access the machines in your cluster.

    Note

    For production {product-title} clusters on which you want to perform installation debugging or disaster recovery on, specify an SSH key that your ssh-agent process uses.