Skip to content

Commit fe28e9d

Browse files
authored
Merge pull request #3829 from Nordix/backport/3814
📖 Update required configurations for Metal³ provider
2 parents bf2030b + 2845ce4 commit fe28e9d

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

docs/book/src/user/quick-start.md

+24-3
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ clusterctl init --infrastructure openstack
275275
{{#/tab }}
276276
{{#tab Metal3}}
277277

278-
Please visit the [Metal3 project][Metal3 getting started guide].
278+
Please visit the [Metal3 project][Metal3 provider].
279279

280280
{{#/tab }}
281281
{{#tab Packet}}
@@ -494,7 +494,27 @@ A full configuration reference can be found in [configuration.md](https://github
494494
{{#/tab }}
495495
{{#tab Metal3}}
496496

497-
Please visit the [Metal3 getting started guide].
497+
```bash
498+
# The URL of the kernel to deploy.
499+
export DEPLOY_KERNEL_URL="http://172.22.0.1:6180/images/ironic-python-agent.kernel"
500+
# The URL of the ramdisk to deploy.
501+
export DEPLOY_RAMDISK_URL="http://172.22.0.1:6180/images/ironic-python-agent.initramfs"
502+
# The URL of the Ironic endpoint.
503+
export IRONIC_URL="http://172.22.0.1:6385/v1/"
504+
# The URL of the Ironic inspector endpoint.
505+
export IRONIC_INSPECTOR_URL="http://172.22.0.1:5050/v1/"
506+
# Do not use a dedicated CA certificate for Ironic API. Any value provided in this variable disables additional CA certificate validation.
507+
# To provide a CA certificate, leave this variable unset. If unset, then IRONIC_CA_CERT_B64 must be set.
508+
export IRONIC_NO_CA_CERT=true
509+
# Disables basic authentication for Ironic API. Any value provided in this variable disables authentication.
510+
# To enable authentication, leave this variable unset. If unset, then IRONIC_USERNAME and IRONIC_PASSWORD must be set.
511+
export IRONIC_NO_BASIC_AUTH=true
512+
# Disables basic authentication for Ironic inspector API. Any value provided in this variable disables authentication.
513+
# To enable authentication, leave this variable unset. If unset, then IRONIC_INSPECTOR_USERNAME and IRONIC_INSPECTOR_PASSWORD must be set.
514+
export IRONIC_INSPECTOR_NO_BASIC_AUTH=true
515+
```
516+
517+
Please visit the [Metal3 getting started guide] for more details.
498518

499519
{{#/tab }}
500520
{{#tab Packet}}
@@ -711,7 +731,8 @@ See the [clusterctl] documentation for more detail about clusterctl supported ac
711731
[KubeadmControlPlane]: ../developer/architecture/controllers/control-plane.md
712732
[kubectl]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
713733
[management cluster]: ../reference/glossary.md#management-cluster
714-
[Metal3 getting started guide]: https://github.com/metal3-io/cluster-api-provider-metal3/
734+
[Metal3 provider]: https://github.com/metal3-io/cluster-api-provider-metal3/
735+
[Metal3 getting started guide]: https://github.com/metal3-io/cluster-api-provider-metal3/blob/master/docs/getting-started.md
715736
[Packet getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-packet#using
716737
[provider components]: ../reference/glossary.md#provider-components
717738
[vSphere getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/

0 commit comments

Comments
 (0)