Document toolboxDocument toolbox

(v2.3.0.0) Installing with x-install Tool (Kubernetes)

The x-install tool is the newest Exostellar installer designed to simplify the setup process. It offers a variety of subcommands to provision a sandbox environment, install Exostellar products, and verify post-installation readiness.

Prerequisites

Before using the x-install tool, ensure that your environment meets the following requirements:

  • Terraform: Version 1.8+

  • kubectl: Version 1.28+

  • Helm: Version 3.14.2+

  • AWS CLI

  • AWS Authentication, Credentials, and Region
    Please properly configure AWS authentication and default region in your local environment.

You can set up credentials using various methods such as command-line options, environment variables, assume role, credentials files, configuration files, etc.

  • Command-line Options

    aws configure sso
    aws s3 ls --profile profile1
  • Environment Variables

    export AWS_ACCESS_KEY_ID=<AccessKeyId> export AWS_SECRET_ACCESS_KEY=<SecretAccessKey> export AWS_SESSION_TOKEN=<SessionToken>
  • Assume role

  • Credentials and Configuration File:
    Update in ~/.aws/credentials and ~/.aws/config

Please ensure the default region is set for deployment. If not set above, use the following command:

Ensure the account has the following IAM permissions:

Use the following command to create a new SSH key pair:

Modify the permission to secure the key:

  • x-install tool: Version 0.0.10+

Platform

Architecture

File

Release Date

Platform

Architecture

File

Release Date

macOS

ARM64

Oct 11, 2024

macOS

x86_64

Oct 11, 2024

Linux

ARM64

Oct 11, 2024

Linux

i386

Oct 11, 2024

Linux

x86_64

Oct 11, 2024

Windows

ARM64

Oct 11, 2024

Windows

i386

Oct 11, 2024

Windows

x86_64

Oct 11, 2024

For macOS users, please grant x-install permissions by clicking the “Allow Anyway” button in the Security settings. This button is available for about an hour after you try to open the app. You can access the Security settings by choosing Apple Menu System Settings, then clicking Privacy & Security in the sidebar.

Installation Steps

1. Create a Standalone Stack

Go to the directory where x-install is downloaded and use the following command to create a standalone stack:

(Please modify the stack name, VPC CIDR, SSH key pair, and region to suit your environment.)

  • The new VPC and EKS cluster will inherit the stack name.

  • The VPC will be assigned the CIDR block 10.0.0.0/16.

  • The EC2 SSH key pair, my-dev-key, will be used to access the Exostellar Management Server.

2. Verify Post-Installation Readiness

After the standalone stack is successfully created, use the following command to check if the stack is ready:

It might take a few attempts for post-install to pass all system units and containers readiness checks, due to infrastructure readiness latency.

3. Add an X-Compute Node to the Standalone EKS Cluster

To add an X-Compute node to the newly created standalone EKS cluster, first SSH into the Exostellar Management Server:

On the server, run the following command to add a new node to the EKS cluster:

The output should display the new nodes as ready:

4. Clean Up

Once the free trial period is over, the entire standalone stack can be deleted with the destroy command:

Additional Help and Support

To explore other subcommands, use the following command for a list of available options: