Install Single-Node Cluster on Ubuntu

We refer to this directory as pa-download-dir in this guide.

The Paragon Automation setup installation bundle consists of the following scripts and TAR files to install each of the component modules:

• davinci.tar.gz, which is the primary installer file.

• infra.tar, which installs the Kubernetes infrastructure components including Docker and Helm.

• ems.tar, which installs the base platform component.

• northstar.tar, which installs the Paragon Pathfinder and Paragon Planner components.

• healthbot.tar, which installs the Paragon Insights component.

• paragon_ui.tar, which installs the Paragon Automation UI component.

• run script, which executes the installer image.

• addons.tar, which installs infrastructure components that are not part of the base Kubernetes installation. The infrastructure components include, IAM, Kafka, ZooKeeper, cert-manager, Ambassador, Postgres, Metrics, Kubernetes Dashboard, Open Distro for Elasticsearch, Fluentd, Reloader, ArangoDB, and Argo.

• helm-charts.tar, which contains all the helm-charts required for installation.

• rhel-84-airgap.tar.gz, which installs Paragon Automation using the air-gap method on nodes only where the base OS is Red Hat Enterprise Linux (RHEL).

config-dir is a user-defined directory on the control host that contains configuration information for a particular installation. The init command automatically creates the config-dir directory if it does not exist. Alternatively, you can create the directory before you execute the init command.

Ensure that you include the dot and slash (./)with the run command.

If you are using the same control host to manage multiple installations of Paragon Automation, you can differentiate between installations by using differently named configuration directories.

Copy the private key that you generated in Configure SSH client authentication to the user-defined config-dir directory. The installer allows the Docker container to access the config-dir directory. The SSH key must be available in the directory for the control host to connect to the cluster nodes.

Ensure that you include the dot "." with the copy command.

1. Customize the inventory file using the inv command:

   The following table lists the configuration options that the inv command prompts for.

   Table 1: inv Command Options

   inv Command Prompts	Description
   Kubernetes master nodes	Enter the IP address of the single Kubernetes cluster node.
   Kubernetes worker nodes	Leave this field empty for a single-node cluster.
   Local storage nodes	The local storage node is prepopulated with the IP address of the single cluster node. This field defines the node that has disk space available for applications that require local storage. Services such as Postgres, ZooKeeper, and Kafka, use local storage or disk space partitioned inside export/local-volumes. This is different from Ceph storage.
   External registry nodes	(Optional) Configure an existing external user registry.
   Kubernetes nodes' username (for example, root)	Configure the user account and authentication methods to authenticate the installer with the cluster nodes. The user account must be root or, in case of non-root users, the account must have superuser (sudo) privileges.
   SSH private key file (optional)	If you chose ssh-key authentication, for the control host to authenticate with the nodes during the installation process, configure the directory (config-dir) where the ansible_ssh_private_key_file is located, and the id_rsa file, as "{{ config-dir }}/id_rsa".
   Kubernetes nodes' password (optional)	If you chose password authentication for the control host to authenticate with the node during the installation process, enter the authentication password directly. Warning: The password is written in plain text. We do not recommend using this option for authentication.
   Kubernetes cluster name (optional)	Enter a name for your Kubernetes cluster.
   Write inventory file?	Click Yes to save the inventory information.

   For example:

2. Alternatively, you can customize the inventory file manually using a text editor.

   Edit the following groups in the inventory file.

   1. Add the IP address of the single Kubernetes node in the master group only.

      The master group identifies the primary nodes, and the node group identifies the worker nodes. You cannot have the same IP address in both master and node groups.

      To create a single-primary-node setup, include the IP address or hostname of the node that will be acting as both primary and worker under the master group. Do not add any IP address or hostname under the node group.

   2. Add the address or hostname of the single Kubernetes node under the local_storage_nodes:children group under master. Do not add anything to the local_storage_nodes:children group under node.

   3. Configure the user account and authentication methods to authenticate the installer in the Ansible control host with the cluster node under the vars group.

   4. (Optional) Specify a name for your Kubernetes cluster in the kubernetes_cluster_name group.

The conf command runs an interactive installation wizard that enables you to choose the components to be installed and configure a basic Paragon Automation setup. The command populates the config.yml file with your input configuration. For advanced configuration, you must edit the config.yml file manually.

Enter the information as prompted by the wizard. Use the cursor keys to move the cursor, use the space key to select an option, and use a or i to toggle selecting or clearing all options. Press Enter to move to the next configuration option. You can skip configuration options by entering a period (.). You can reenter all your choices by exiting the wizard and restarting from the beginning. The installer allows you to exit the wizard after you save the choices that you already made or to restart from the beginning. You cannot go back and redo the choices that you already made in the current workflow without exiting and restarting the wizard altogether.

The following table lists the configuration options that the conf command prompts for:

[edit groups northstar]
root@system# show protocols bgp group northstar
type internal;
family traffic-engineering {
    unicast;
}
export TE;
allow 10.xx.43.0/24;

[edit groups northstar]
root@system# show policy-options policy-statement TE
from family traffic-engineering;
then accept;

[edit protocols bgp group BGP-LS]
root@vmx101# show | display set 
set protocols bgp group BGP-LS family traffic-engineering unicast
set protocols bgp group BGP-LS peer-as 11
set protocols bgp group BGP-LS allow 10.x.43.1
set protocols bgp group BGP-LS export TE

[edit protocols bgp group BGP-LS]
root@vmx101# show | display set
set protocols bgp group BGP-LS family traffic-engineering unicast
set protocols bgp group BGP-LS peer-as 11
set protocols bgp group BGP-LS neighbor 10.xx.43.1
set protocols bgp group BGP-LS passive
set protocols bgp group BGP-LS export TE

set protocols rsvp interface interface.unit

set protocols isis interface interface.unit
set protocols isis traffic-engineering igp-topology
Or
set protocols ospf area area interface interface.unit
set protocols ospf traffic-engineering igp-topology

set protocols mpls interface interface.unit
set protocols mpls traffic-engineering database import igp-topology

The config.yml file consists of an essential section at the beginning of the file that corresponds to the configuration options that the installation wizard prompts you to enter. The file also has an extensive list of sections under the essential section that allows you to enter complex configuration values directly in the file.

The following options are available.

• Configure Open Distro, which is used to consolidate and index application logs. To configure Open Distro, set install_opendistro_es and install_fluentd to true.

• Set the opendistro_es_admin_password password to log in to the Kibana application. Kibana is a visualization tool used to search logs using keywords and filters.

  By default, the username is preconfigured as admin in #opendistro_es_admin_user: admin and the install_opendistro_es option is set to true to replace the Elasticsearch version with Open Distro. Use admin as username and this password to log in to Kibana.

  By default, data is retained on the disks for seven days, before being purged, in a production deployment. You can edit the number of days to a smaller number in opendistro_es_retain if your disk size is low.

  If you do not configure the opendistro_es_admin_password password, the installer generates a random password. You can retrieve the password using the command:

  # kubectl -n kube-system get secret opendistro-es-account -o jsonpath={..password} | base64 -d

• Set the iam_skip_mail_verification configuration option to true for user management without SMTP by Identity Access Management (IAM). By default, this option is set to false for user management with SMTP. You must configure SMTP in Paragon Automation so that the Paragon Automation users can be notified when their account is created, activated, locked, or when the password is changed for their account.

• Configure the callback_vip option with an IP address different from that of the VIP for the ingress controller. You can configure a separate IP address, which is a part of the MetalLB pool of addresses, to enable segregation of management and data traffic from the southbound and northbound interfaces. By default, callback_vip is assigned the same or one of the addresses of the ingress controller.

Save and exit the file after you finish editing it.

By default, Ambassador uses a locally generated certificate signed by the Kubernetes cluster-internal CA.

The installation time to install the configured cluster depends on the complexity of the cluster. A basic setup installation takes at least 45 minutes to complete.

NTP synchronization is checked at the start of deployment. If clocks are out of sync, deployment will fail. If you are installing Paragon Automation on an existing Kubernetes cluster, the deploy command upgrades the currently deployed cluster to the latest Kubernetes version. The command also upgrades the Docker CE version, if required. If Docker EE is already installed on the nodes, the deploy command will not overwrite it with Docker CE. When upgrading the Kubernetes version or the Docker version, the command performs the upgrade sequentially on one node at a time. Each node is cordoned off and removed from scheduling and upgrades are performed, Kubernetes is restarted on the node, and the node is finally uncordoned and brought back into scheduling.

Use a text editor to configure the following recommended information for Paragon Insights in the limits.conf and sysctl.conf files. These values set the soft and hard memory limits for influx DB memory requirements. If you do not set these limits, you might see errors such as “out of memory” or “too many open files” because of default system limits.