openstack/openstack-helm
Code Issues Proposed changes

docs: simplify Ingress hostname example

Browse Source 
The example for host_fqdn_override was wrong since it was missing the
nested "host" key. Having the user change around their DNS resolution to
resolve values inside of their cluster is a little awkward so instead
utilize sslip.io to give a bit more of a seamless experience.

Change-Id: I7e283da2b1db6e95df5b315a724047128193043b
Signed-off-by: Doug Goldstein <doug.goldstein@rackspace.com>
This commit is contained in:
Doug Goldstein 2024-07-08 17:26:56 -05:00
parent ef1e72c1d0
commit 295beb3d0c
No known key found for this signature in database
GPG Key ID: 11F806DA366D8DEC
1 changed files with 18 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
doc/source/install/prerequisites.rst
View File

@ -161,47 +161,12 @@ Openstack API pods.
By default, the ``Ingress`` objects will only contain rules for the By default, the ``Ingress`` objects will only contain rules for the
``openstack.svc.cluster.local`` DNS domain. This is the internal Kubernetes domain ``openstack.svc.cluster.local`` DNS domain. This is the internal Kubernetes domain
and it is not supposed to be used outside the cluster. However, we can use and it is not supposed to be used outside the cluster.
the Dnsmasq to resolve the ``*.openstack.svc.cluster.local`` names to the
``LoadBalancer`` service IP address.
The following command will start the Dnsmasq container with the necessary configuration: You can use the ``host_fqdn_override`` for the endpoints to set an alternate
hostname using a service like `sslip.io`_. Assuming your services are exposed
.. code-block:: bash at ``172.24.128.100`` as is referenced in the Service above, you could use
``<service>.172-24-128-100.sslip.io``
docker run -d --name dnsmasq --restart always \
--cap-add=NET_ADMIN \
--network=host \
--entrypoint dnsmasq \
docker.io/openstackhelm/neutron:2024.1-ubuntu_jammy \
--keep-in-foreground \
--no-hosts \
--bind-interfaces \
--address="/openstack.svc.cluster.local/172.24.128.100" \
--listen-address="172.17.0.1" \
--no-resolv \
--server=8.8.8.8
The ``--network=host`` option is used to start the Dnsmasq container in the
host network namespace and the ``--listen-address`` option is used to bind the
Dnsmasq to a specific IP. Please use the configuration that suits your environment.
Now we can add the Dnsmasq IP to the ``/etc/resolv.conf`` file
.. code-block:: bash
echo "nameserver 172.17.0.1" > /etc/resolv.conf
or alternatively the ``resolvectl`` command can be used to configure the systemd-resolved.
.. note::
In production environments you probably choose to use a different DNS
domain for public Openstack endpoints. This is easy to achieve by setting
the necessary chart values. All Openstack-Helm charts values have the
``endpoints`` section where you can specify the ``host_fqdn_override``.
In this case a chart will create additional ``Ingress`` resources to
handle the external domain name and also the Keystone endpoint catalog
will be updated.
Here is an example of how to set the ``host_fqdn_override`` for the Keystone chart: Here is an example of how to set the ``host_fqdn_override`` for the Keystone chart:
@ -210,7 +175,19 @@ Here is an example of how to set the ``host_fqdn_override`` for the Keystone cha
endpoints: endpoints:
identity: identity:
host_fqdn_override: host_fqdn_override:
public: "keystone.example.com" public:
host: "keystone.172-24-128-100.sslip.io"
.. note::
In production environments you probably choose to use a different DNS
domain for public OpenStack endpoints. This is easy to achieve by setting
the necessary chart values. All Openstack-Helm charts values have the
``endpoints`` section where you can specify the ``host_fqdn_override``.
In this case a chart will create additional ``Ingress`` resources to
handle the external domain name and also the Keystone endpoint catalog
will be updated.
.. _sslip.io: https://sslip.io/
Ceph Ceph
---- ----