docs/doc/source/system_configuration/kubernetes/user-host-entries-configuration-9ad4c060eb15.rst
Dinesh Neelapu 9fc1cbff75 Configurable Local Host Entries
Updated the steps to configure local host entries.
Add acronym to list.

Story: 2010835
Task: 49688

Change-Id: I11313ba597e0443205be8874b4f8f9297581f417
Signed-off-by: Dinesh Neelapu <dinesh.neelapu@windriver.com>
2024-05-16 13:54:09 +00:00

4.5 KiB

User-Defined Host Entries Configuration

You can configure user-defined host entries for external resources that are not maintained by records resolvable by the external server(s) (i.e. nameservers in system dns-show/dns-modify). This functionality enables the configuration of local host records, supplementing hosts resolvable by external server(s).

starlingx

User-defined host entries can be configured at bootstrap time and/or post-deployment.

partner

The following methods are enabled to configure user host records/entries.

  • Configure User-Defined Host Entries During Bootstrap <bootstrap-user-host-entries-configuration-9ad4c060eb15>
  • Configure User-Defined Host Entries via System Inventory API/CLI <CLI-user-host-entries-configuration-9ad4c060eb15>

partner

Configure User-Defined Host Entries During Bootstrap

During the bootstrap phase, update the Ansible playbook override file, localhost.yaml <hostname.yaml>, with the following data within the user_dns_host_records section.

To add host records, use the following command syntax:

user_dns_host_records:
  <host-record-name>: <fqdn>[,<fqdn>...],[<IPv4-address>],[<IPv6-address>][,<TTL>]

Where, can be optionally provided and fqdn = fully qualified domain name.

For example:

user_dns_host_records:
  test-server: example.com,192.168.0.1,1234::100,300
  host1: host,example2.com,127.0.0.1

Note

Upon system initialization, you can observe that data has been updated within the system database, and it can be listed using the system CLI.

Configure User-Defined Host Entries via System Inventory API/CLI

After system deployment, update host records using the CLI. Source the script /etc/platform/openrc to obtain administrative privileges and use the following procedure:

  1. Use the following command syntax to add the parameter.

    system service-parameter-add dns host-record <host-record-name>=<fqdn>[,<fqdn>...],[<IPv4-address>],[<IPv6-address>][,<TTL>]
    system service-parameter-apply dns

    Where fqdn = fully qualified domain name.

    For example:

    system service-parameter-add dns host-record test-server1=host1,testserver1.com,127.0.0.1

    image

  2. Use the following command syntax to modify the parameter.

    system service-parameter-modify dns host-record <host-record-name>:<fqdn>[,<fqdn>...],[<IPv4-address>],[<IPv6-address>][,<TTL>]
    system service-parameter-apply dns

    Where fqdn = fully qualified domain name.

    The following example shows the command syntax to add another name for the existing host entry.

    Example:

    system service-parameter-modify dns host-record test-server1=host1,host,testserver1.com,127.0.0.1

    image

  3. Follow the steps below to delete the parameter.

    1. Run the command to display the service parameter list for host-record service-parameter type.

      system service-parameter-list | grep host-record

      Copy the of the parameter that needs to be deleted.

    2. Run the command to delete the entry.

      system service-parameter-delete <uuid>

      For example:

      system service-parameter-delete  a24e147f-2d13-4d7b-a8e7-47a1d77b95b5

partner