Verify Ingress
Before you start¶
Goal
- Ensure Ingress settings are correct.
Prerequisites
- Complete the initial Altair SLC Hub install.
- Know the ingress addresses Network.
- Altair SLC Hub configuration privileges for the host.
Verify or configure Hub ingress address¶
First it is important to understand the network you are installing to and the ingress addresses used. This is explained in the planning section Ingress.
The Altair SLC Hub ingress and internal ingress addresses may need to be defined in the Altair SLC Hub configuration.
The ingress address is used, for example, when creating emails that might contain links to portal pages and when constructing redirect responses during the authentication process. This ingress address therefore needs to be the address by which the Hub can be accessed from browsers.
The internal ingress address name may be different from the address used in browsers. This is likely where the hub is installed on a private network, such as in cloud providers. Here machines may communicate with each other using internal addresses, but browsers will use a different external address.
The installation processes initialized the hostname to the fully qualified hostname of the host, but as indicated, this may not always be accurate. To view the value of the external address setting, execute the following command:
hubctl config print ingress.hostname
If the hostname needs to be changed, create a copy of the [etc directory]/config.d/ingress.yaml file with a lexicographically greater name, for example, [etc directory]/config.d/ingress_custom.yaml and edit the ingress.hostname value in that file.
The default port for accessing the Altair SLC Hub portal and REST API is 9090. This can be changed if required. To change the port, edit the ingress_custom.yaml file and modify the required port setting for the ingress.port configuration property. For example, the contents of that file could look like the following:
ingress:
hostname: machine.domain.local
port: 9090
Note
The Altair SLC Hub ingress server is run with NET_BIND_PORT capability, so it can bind to ports less than 1024
Note
If the port is set to 80 for HTTP or 443 for HTTPS, it is necessary to also manually set the url property to
${ingress.scheme}://${ingress.hostname} (that is, remove the :${ingress.port} part).
For more information on the Altair SLC Hub configuration process and how the configuration files are processed see Configuration.
The internal ingress address may also be checked:
hubctl config print internalingress.hostname
Verification¶
Verify ingress
- The ingress should match the external address of the host.
Running the following command:
hubctl config print ingress.url