CONFIGURATION & INSTALLATION

‍

To facilitate a successful XTRA deployment, three key steps should be followed for proper configuration and installation of the XTRA software: PREPARE, CONFIGURE, and INSTALL.

PREPARE

After registering, customers will receive a license file and authentication credentials for HOPR's container repository. The license file is a crucial component that contains important information about the specific features available to the customer. It is essential to keep the license file readily accessible during the application installation process. Additionally, authentication credentials are necessary for accessing any updates or new features from the repository after the initial installation. Safeguarding the license file and authentication credentials is of utmost importance to ensure uninterrupted access to the application's features.

License File

Each registered customer will receive both the HOPR license file and its corresponding base64-encoded version. The base64-encoded version of the file is provided to simplify the implementation process within your container runtime environment. It offers a more straightforward integration method, while the regular license file maintains its original format and structure. Having both versions ensures flexibility in using the license file according to your specific requirements and preferences.

License File

Key: 46O0IJNIM9VPQk4Be7hO72S4mUCdI9B6JmjbD0m4Vv0=
License with expiry 2022-10-08T23:59:59.999999 created at: hopr.lic

Base64 Version of License File

WwIWOuohjcSlXFjaG+TcCOuk7AXxlM8xaM3r5eTubnnVN+bY2m2DB87CieiTEhhtZ6lKszmoP0GDiwYOVtlpsx1KiuTn1Q16ZODBgWzXFiOpQVNSgQrO938LKzORaoPxTLEk

‍

Hopr Repository Authentication

Container repository access is provided through a Docker configuration file, which can be used for both direct access via Docker pull and as a Kubernetes image pull secret. The configuration file, in the format of config.json, includes plaintext user and password information. It is of utmost importance that this file be protected and kept secure to prevent unauthorized access. Proper measures should be taken to ensure the confidentiality and integrity of the config.json file, as it contains sensitive authentication information. Below is an example of the config.json format:

{
  "auths": {
    "repo.hoprapi.com": {
      "username": "nick",
      "password": "hoprXTRA12345",
      "email": "dev@hopr.co",
      "auth": "bmljazpob3ByWFRSQTEyMzQ1"
    }
  }
}

‍

The auth field in the config.json file represents the Base64 representation of basic authentication. You can use the echo command with the -n flag to prevent appending a newline character. Then, pipe the output to the base64 command. For example, if the username is "nick" and the password is "hoprXTRA12345", the command would be:

echo -n "nick:hoprXTRA12345" | base64

‍

CONFIGURE

To prepare for the installation of XTRA, it is necessary to have several deployment configuration files. These files contain the required settings and parameters for deploying the application in a specific environment. Here are a couple of options for setting up deployment configuration files:

configuration template

Hopr offers customers the option to use ytt templates for setting up XTRA configuration files in their environment. These configuration template files are provided as a convenience, offering a pre-configured framework for customers to customize according to their specific requirements. The templates include pre-defined settings, parameters, and options that can be easily modified to align with the customer's environment. By utilizing these templates, customers can save time and effort, as they do not have to create configurations from scratch. This streamlined approach enables a faster and more efficient setup process for deploying XTRA.

ytt template

ytt is an open-source tool developed by Carvel, which operates as a set of instructions or rules to generate or modify files or configurations consistently and reproducibly. It can be compared to a recipe that outlines the steps and ingredients needed to create a specific output, with the flexibility to adjust the components or procedures to customize the final result. Hopt has created a ytt template that customers can utilize. This template provides a standardized configuration for deploying XTRA while allowing customers the flexibility to customize their deployments according to their specific environment requirements. By leveraging the Hopr ytt template, customers can achieve a consistent deployment approach while tailoring the configuration to their individual needs.

Hopt utilizes ytt templates to offer customers standard configuration files that can be customized to suit their specific environments. You can refer to the Hopr ytt template guide HERE for more information on how to use the template effectively.

Note: To utilize Hopr's XTRA ytt template, the ytt tool must be installed in the customer's environment.

YAML Files

Another option available to consumers for setting up XTRA configuration files is to use YAML files to define and apply the necessary resources.

You can refer to the guide on the required YAML files for XTRA configuration: HERE

INSTALL

Once the configuration files are properly set and customized, the next step is to apply the deployment file to your environment.

Example

‍If leveraging Hopr's ytt template:

ytt -f. | kubectl apply -f-

‍

If installing to kubernetes environment with YAML files:

kubectl apply -f config.yaml

‍

Example Output

namespace/hopr-p2p created
configmap/hopr-envoyconfig created
configmap/hopr-webserver-script created
secret/hopr-registrycreds created
secret/hopr-license created
deployment.apps/hopr-p2p created
service/hopr-webserver-service created

‍

Once installed you can verify XTRA is installed correctly by checking the logs on the containers:

NOTE: - This example utilizes the optional curl-test pod that can be deployed with XTRA

Kubernetes Environment Example:
Command: kubectl logs -n <namespace> <pod-name> -c <container-name>
Example:

kubectl logs -n hopr-test hopr-test-6d4687599c-w9p9b -c curl-test

‍Output:

Congratulations. XTRA is configured correctly.

Sleeping 30 ...‍

‍