Prepare the Equinix Metal configuration

  1. On the bootstrap node, change the directory to kaas-bootstrap.

  2. In templates/equinixmetalv2/equinix-config.yaml.template, modify spec:projectID and spec:apiToken:value using the values obtained in the previous steps. For example:

    spec:
      projectID: g98sd6f8-dc7s-8273-v8s7-d9v7395nd91
      apiToken:
        value: Bi3m9c7qjYBD3UgsnSCSsqs2bYkbK
    
  3. In templates/equinixmetalv2/cluster.yaml.template:

    • Modify the default configuration of the Equinix Metal facility depending on the previously prepared capacity settings as described in Verify the capacity of the Equinix Metal facility:

      providerSpec:
        value:
          # ...
          facility: am6
      
    • Modify network parameters by applying the following snippet:

      providerSpec:
        value:
          # ...
          network:
            vlanId: "<SET_EQUINIX_VLAN_ID>"
            loadBalancerHost: 192.168.0.7
            metallbRanges:
            - 192.168.0.129-192.168.0.200
            cidr: 192.168.0.0/24
            gateway: 192.168.0.1
            dhcpRanges:
              - 192.168.0.10-192.168.0.50
            includeRanges:
              - 192.168.0.51-192.168.0.128
      

      Replace <SET_EQUINIX_VLAN_ID> with the ID of the VLAN created by the Terraform templates. The value is expected to be a string wrapped in double quotes.

    • In the regional section, replace SET_EQUINIX_NTP_SERVER with 192.168.0.1:

      spec:
        # ...
        providerSpec:
          value:
            kaas:
              # ...
              regional:
                - helmReleases:
                  - name: equinix-provider
                    values:
                      config:
                        lcm:
                          ntp:
                            servers:
                            - 192.168.0.1
                  provider: equinixmetalv2
      

      For the full description of these parameters, see Bootstrap a management cluster.

    • Add projectSSHKeys that is the list of the Equinix Metal project SSH key names to be attached to cluster machines. These keys are required for access to the Equinix Metal out-of-band console Serial Over SSH (SOS) to debug provisioning failures. We recommend adding at least one project SSH key per cluster.

      Example of the project SSH keys configuration:

      providerSpec:
        value:
          # ...
          projectSSHKeys:
          - <projectSSHKeyName>
      

      To create an SSH key in an Equinix Metal project:

      1. Log in to the Equinix Metal console.

      2. Select the project that you want to use for the Container Cloud deployment.

      3. In the Project Settings tab, select Project SSH Keys and click Add New Key.

      4. Enter the Key Name and Public Key values and click Add.

  4. Add the following parameters to bootstrap.env:

    KAAS_EQUINIXMETALV2_ENABLED=true
    
    KAAS_BM_PXE_BRIDGE=br0
    KAAS_BM_PXE_IP=192.168.0.5
    KAAS_BM_PXE_MASK=24
    BOOTSTRAP_METALLB_ADDRESS_POOL=192.168.0.129-192.168.0.200
    
    export HTTPS_PROXY=http://192.168.0.1:3128
    export HTTP_PROXY=http://192.168.0.1:3128
    

    To learn more about these parameters, see Bootstrap a management cluster.

  5. Optional. In templates/equinixmetalv2/machines.yaml.template, modify the default configuration of the Equinix Metal machine type. The minimal required type is c3.small.x86.

    providerSpec:
      value:
        # ...
        machineType: c3.small.x86
    
  6. Re-verify that the selected Equinix Metal facility for the management cluster bootstrap is still available and has enough capacity:

    packet-cli capacity check --facility $EQUINIX_FACILITY --plan $EQUINIX_MACHINE_TYPE --quantity $MACHINES_AMOUNT
    

    In the system response, if the value in the AVAILABILITY section has changed from true to false, find an available facility and update the previously configured facility field in cluster.yaml.template.

    For details about the verification procedure, see Verify the capacity of the Equinix Metal facility.