Page Comparison

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+
Gitkubectl: Version 21.3428+
x-install toolHelm: Version 03.014.10+AWS Account: Ensure the following IAM permissions are in place:2+
AWS CLI
AWS Authentication, Credentials, and Region
Please properly configure AWS authentication and default region in your local environment.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:ListAssociations", "ec2:RunInstances", "ec2:DescribeSubnets", "ec2:DescribeKeyPairs", "ec2:DescribeVpcs", "ec2:DescribeSecurityGroups", "ec2:DescribeSecurityGroupRules", "ec2:AuthorizeSecurityGroupIngress", "ec2:CreateTags", "ec2:CreateSecurityGroup", "sns:ListTopics", "s3:CreateBucket", "iam:AttachRolePolicy", "iam:CreateRole", "iam:ListRoles", "iam:TagRole", "iam:PutRolePolicy", "iam:CreateInstanceProfile", "iam:AddRoleToInstanceProfile", "iam:PassRole", "ec2:DescribeInstances", "ec2:DescribeInstanceTypes", "ec2:RunInstances", "ec2:DescribeImages", "ec2:DescribeImageAttribute", "ec2:DescribeAvailabilityZones", "ec2:DescribeAccountAttributes", "ec2:DescribeRouteTables

Expand

title	IAM Permissions for the AWS Account

Code Block

AWS Authentication and Credentials Setup Methods

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
Code Block
language bash
aws configure sso
Code Block
language bash
aws s3 ls --profile profile1

Environment Variables

Code Block

language	bash

export AWS_ACCESS_KEY_ID=<AccessKeyId>
export AWS_SECRET_ACCESS_KEY=<SecretAccessKey>
export AWS_SESSION_TOKEN=<SessionToken>

Assume role

Code Block
aws sts assume-role \ --role-arn arn:aws:iam::123456789012:role/xaccounts3access \ --role-session-name s3-access-example

Credentials and Configuration File:
Update in ~/.aws/credentials and ~/.aws/config
Code Block
language bash
aws configure

Info

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

Code Block

language	bash

aws configure set default.region us-east-2

Ensure the account has the following IAM permissions:

Expand

title	IAM Permissions for the AWS Account

Code Block

language	json

{
	"Version": "2012-10-17",
	"Statement": [
		{
			"Effect": "Allow",
			"Action": [
				"ssm:ListAssociations",
				"ec2:DescribeNetworkAclsRunInstances",
				"ec2:DescribeInstanceStatusDescribeSubnets",
				"ec2:DescribeAddressesDescribeKeyPairs",
				"ec2:DescribeDhcpOptionsDescribeVpcs",
				"ec2:DescribeSnapshotsDescribeSecurityGroups",
				"ec2:DescribeVolumesDescribeSecurityGroupRules",
				"ec2:DescribeVolumeStatusAuthorizeSecurityGroupIngress",
				"ec2:DescribeVolumesModificationsCreateTags",
				"cloudwatchec2:DescribeAlarmsCreateSecurityGroup",
				"cloudwatchsns:ListMetricsListTopics",
				"iams3:ListUsersCreateBucket",
				"iam:ListAccessKeysAttachRolePolicy",
				"iam:CreateAccessKeyCreateRole",
				"ec2iam:AuthorizeSecurityGroupEgressListRoles",
				"iam:ListPolicyVersionsTagRole",
				"eksiam:ListClustersPutRolePolicy",
				"eksiam:DescribeClusterCreateInstanceProfile",
				"eksiam:ListNodegroupsAddRoleToInstanceProfile",
				"eksiam:DescribeNodegroupPassRole",
				"eksec2:DescribeAddonDescribeInstances",
				"eksec2:ListAddonsDescribeInstanceTypes",
				"eksec2:DescribeIdentityProviderConfigRunInstances",
				]"ec2:DescribeImages",
				"Resource"ec2: DescribeImageAttribute"*",
		},
		{"ec2:DescribeAvailabilityZones",
				"Effectec2:DescribeAccountAttributes":,
"Allow				"ec2:DescribeRouteTables",
				"Action": [ec2:DescribeNetworkAcls",
				"s3ec2:PutObjectDescribeInstanceStatus",
				"s3ec2:GetObjectDescribeAddresses",
			]	"ec2:DescribeDhcpOptions",
				"Resourceec2:DescribeSnapshots":,
				"arn:aws:s3:::cf-template*"
		}ec2:DescribeVolumes",
		{
			"Sid"ec2: DescribeVolumeStatus"Statement1",
				"Effect": "Allowec2:DescribeVolumesModifications",
				"Actioncloudwatch:DescribeAlarms":,
[
				"ekscloudwatch:CreateClusterListMetrics",
				"eksiam:DescribeClusterListUsers",
				"eksiam:DeleteClusterListAccessKeys",
				"eksiam:ListClustersCreateAccessKey",
				"eksec2:UpdateClusterConfigAuthorizeSecurityGroupEgress",
				"eksiam:UpdateClusterVersionListPolicyVersions",
				"eks:CreateNodegroupListClusters",
				"eks:DescribeNodegroupDescribeCluster",
				"eks:ListNodegroups",
				"eks:UpdateNodegroupConfigDescribeNodegroup",
				"eks:UpdateNodegroupVersionDescribeAddon",
				"eks:DescribeAddonVersionsListAddons",
				"eks:CreateAddonDescribeIdentityProviderConfig"
			],
				"Resource"eks:DeleteAddon" "*"
		},
		{
			"eks:DescribeAddonEffect": "Allow",
				"Action"eks:ListAddons", [
				"ekss3:UpdateAddonPutObject",
				"ekss3:AccessKubernetesApiGetObject"
			],
				"Resource"eks:ListAccessPolicies" "*"
		},
		{
			"Sid"eks:ListAccessEntries "Statement1",
				"Effect"eks:ListIdentityProviderConfigs "Allow",
				"Action"eks:DescribeAccessEntry", [
				"eks:ListPodIdentityAssociationsCreateCluster",
				"eks:ListAssociatedAccessPoliciesDescribeCluster",
				"eks:CreateAccessEntryDeleteCluster",
				"eks:AssociateAccessPolicyListClusters",
			],
			"Resource"eks: "*"
		}UpdateClusterConfig",
		{
			"Effect": "Alloweks:UpdateClusterVersion",
				"Actioneks:CreateNodegroup":,
[
				"iameks:DeleteRolePolicyDescribeNodegroup",
				"iameks:DeleteRoleListNodegroups",
				"iameks:GetRoleUpdateNodegroupConfig",
				"iameks:ListPoliciesUpdateNodegroupVersion",
				"iameks:ListAttachedRolePoliciesDescribeAddonVersions",
				"iameks:CreateServiceLinkedRoleCreateAddon",
				"iameks:RemoveRoleFromInstanceProfileDeleteAddon",
				"iameks:DeleteInstanceProfileDescribeAddon",
				"iameks:ListEntitiesForPolicyListAddons",
				"iameks:GetInstanceProfileUpdateAddon",
				"iameks:ListInstanceProfilesAccessKubernetesApi",
				"iameks:ListInstanceProfilesForRoleListAccessPolicies",
				"iameks:ListOpenIDConnectProvidersListAccessEntries",
				"iameks:GetOpenIDConnectProviderListIdentityProviderConfigs",
				"iameks:GetRolePolicyDescribeAccessEntry",
				"ec2eks:RevokeSecurityGroupIngressListPodIdentityAssociations",
				"ec2eks:DeleteSecurityGroupListAssociatedAccessPolicies",
				"ec2eks:StopInstancesCreateAccessEntry",
				"ec2eks:TerminateInstancesAssociateAccessPolicy",
			],
			"Resource"ec2:DescribeVpcAttribute" "*"
		},
		{
			"ec2:DescribeTagsEffect": "Allow",
				"Action"ec2:DescribeNetworkInterfaces", [
				"cloudformationiam:DeleteStackDeleteRolePolicy",
				"ec2iam:RevokeSecurityGroupEgressDeleteRole",
				"iam:ListRolePoliciesGetRole",
				"iam:CreatePolicyListPolicies",
				"iam:GetPolicyListAttachedRolePolicies",
				"ec2iam:DescribeInstanceAttributeCreateServiceLinkedRole",
				"iam:GetPolicyVersionRemoveRoleFromInstanceProfile",
			],
			"Resource"iam: "*"
		}DeleteInstanceProfile",
		{
			"Sid": "AdditionalPermissionsiam:ListEntitiesForPolicy",
				"Effect": "Allowiam:GetInstanceProfile",
				"Action": [iam:ListInstanceProfiles",
				"iam:DetachRolePolicyListInstanceProfilesForRole",
				"ec2iam:CreateVpcListOpenIDConnectProviders",
				"ec2iam:DeleteVpcGetOpenIDConnectProvider",
				"ec2iam:CreateSubnetGetRolePolicy",
				"ec2:DeleteSubnetRevokeSecurityGroupIngress",
				"ec2:CreateRouteTableDeleteSecurityGroup",
				"ec2:CreateRouteStopInstances",
				"ec2:AssociateRouteTableTerminateInstances",
				"ec2:ReplaceRouteTableAssociationDescribeVpcAttribute",
				"ec2:DeleteRouteTableDescribeTags",
				"ec2:CreateInternetGatewayDescribeNetworkInterfaces",
				"ec2cloudformation:AttachInternetGatewayDeleteStack",
				"ec2:AllocateAddressRevokeSecurityGroupEgress",
				"ec2iam:ReleaseAddressListRolePolicies",
				"ec2iam:CreateNatGatewayCreatePolicy",
				"ec2iam:DeleteNatGatewayGetPolicy",
				"cloudformationec2:UpdateStackDescribeInstanceAttribute",
				"cloudformationiam:DeleteChangeSetGetPolicyVersion",
				"cloudformation:DescribeChangeSet"],
				"Resource"cloudformation:ExecuteChangeSet" "*"
		},
		{
			"Sid"cloudtrail:DescribeTrails "AdditionalPermissions",
				"Effect"cloudtrail:GetTrailStatus "Allow",
				"Action"cloudtrail:GetEventSelectors", [
				"logsiam:DescribeLogGroupsDetachRolePolicy",
				"logsec2:DescribeLogStreamsCreateVpc",
				"logsec2:GetLogEventsDeleteVpc",
				"logsec2:FilterLogEventsCreateSubnet",
				"iamec2:GetUserPolicyDeleteSubnet",
				"iamec2:GetGroupPolicyCreateRouteTable",
				"iamec2:GetPolicyVersionCreateRoute",
				"ec2:CreateLaunchTemplateAssociateRouteTable",
				"ec2:DescribeLaunchTemplatesReplaceRouteTableAssociation",
				"ec2:DescribeInternetGatewaysDeleteRouteTable",
				"ec2:ModifyVpcAttributeCreateInternetGateway",
				"ec2:ModifySubnetAttributeAttachInternetGateway",
				"ec2:DescribeNatGatewaysAllocateAddress",
				"ec2:DescribeInstanceTypeOfferingsReleaseAddress",
				"ec2:DescribeEgressOnlyInternetGatewaysCreateNatGateway",
				"ec2:DescribeLaunchTemplateVersionsDeleteNatGateway",
				"ec2cloudformation:DeleteLaunchTemplateUpdateStack",
				"ekscloudformation:TagResourceDeleteChangeSet",
				"elasticloadbalancingcloudformation:CreateLoadBalancerDescribeChangeSet",
				"elasticloadbalancingcloudformation:DescribeLoadBalancersExecuteChangeSet",
				"elasticloadbalancingcloudtrail:DeleteLoadBalancerDescribeTrails",
				"elasticloadbalancingcloudtrail:CreateTargetGroupGetTrailStatus",
				"elasticloadbalancingcloudtrail:DescribeTargetGroupsGetEventSelectors",
				"elasticloadbalancinglogs:RegisterTargetsDescribeLogGroups",
				"autoscalinglogs:CreateAutoScalingGroupDescribeLogStreams",
				"autoscalinglogs:UpdateAutoScalingGroupGetLogEvents",
				"autoscalinglogs:DeleteAutoScalingGroupFilterLogEvents",
				"autoscalingiam:DescribeAutoScalingGroupsGetUserPolicy",
				"autoscalingiam:DescribeScalingActivitiesGetGroupPolicy",
				"cloudformationiam:DescribeChangeSetGetPolicyVersion",
				"cloudformationec2:ExecuteChangeSetCreateLaunchTemplate",
				"s3ec2:CreateBucketDescribeLaunchTemplates",
				"s3ec2:DeleteBucketDescribeInternetGateways",
				"s3ec2:ListBucketModifyVpcAttribute",
				"s3ec2:GetBucketLocationModifySubnetAttribute",
				"s3ec2:GetBucketPolicyDescribeNatGateways",
				"s3ec2:PutBucketPolicyDescribeInstanceTypeOfferings",
			]	"ec2:DescribeEgressOnlyInternetGateways",
				"Resource"ec2: DescribeLaunchTemplateVersions"*",
		}
	]
}		"ec2:DeleteLaunchTemplate",
				"eks:TagResource",
				"elasticloadbalancing:CreateLoadBalancer",
				"elasticloadbalancing:DescribeLoadBalancers",
				"elasticloadbalancing:DeleteLoadBalancer",
				"elasticloadbalancing:CreateTargetGroup",
				"elasticloadbalancing:DescribeTargetGroups",
				"elasticloadbalancing:RegisterTargets",
				"autoscaling:CreateAutoScalingGroup",
				"autoscaling:UpdateAutoScalingGroup",
				"autoscaling:DeleteAutoScalingGroup",
				"autoscaling:DescribeAutoScalingGroups",
				"autoscaling:DescribeScalingActivities",
				"cloudformation:DescribeChangeSet",
				"cloudformation:ExecuteChangeSet",
				"s3:CreateBucket",
				"s3:DeleteBucket",
				"s3:ListBucket",
				"s3:GetBucketLocation",
				"s3:GetBucketPolicy",
				"s3:PutBucketPolicy",
				"aws-marketplace:ViewSubscriptions",
				"ec2:DescribeKeyPairs",
				"ec2:CreateKeyPair"
			],
			"Resource": "*"
		}
	]
}

Valid AWS Marketplace Subscriptions for Exostellar Management Server, Exostellar Controller, Exostellar Worker AMIs for the same AWS account
SSH Key

Expand

title	SSH Key Creation

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

Code Block

language	bash

aws ec2 create-key-pair --key-name 'my-dev-key' --query 'KeyMaterial' --output text --region us-east-2 > my-dev-key.pem

Modify the permission to secure the key:

Code Block

language	bash

chmod 400 my-dev-key.pem

x-install tool: Version 0.0.10+

Expand

title	x-install Download Options

Platform

Architecture

File

Release Date

macOS

ARM64

View file

name	x-install-darwin-arm64-.0.0.10.tar.gz

11 Oct 2024

macOS

x86_64

View file

name	x-install-darwin-x86_64-.0.0.10.tar.gz

11 Oct 2024

Linux

ARM64

View file

name	x-install-linux-arm64-.0.0.10.tar.gz

11 Oct 2024

Linux

i386

View file

name	x-install-linux-i386-.0.0.10.tar.gz

11 Oct 2024

Linux

x86_64

View file

name	x-install-linux-x86_64-.0.0.10.tar.gz

11 Oct 2024

Windows

ARM64

View file

name	x-install-windows-arm64-.0.0.10.zip

11 Oct 2024

Windows

i386

View file

name	x-install-windows-i386-.0.0.10.zip

11 Oct 2024

Windows

x86_64

View file

name	x-install-windows-x86_64-.0.0.10.zip

11 Oct 2024

Info
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

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

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

Code Block

language	bash

x-install create-standalone \
  --stack-name=xio-standalone \
  --vpc-cidr=10.0.0.0/16 \
  --ssh-key-pair-name=my-dev-key \
  --region=us-westeast-12

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:

Code Block

language	bash

x-install post-install --stack-name=xio-standalone=xio-standalone --ssh-private-key-file=my-dev-key.pem --ssh-username=rocky

Info
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:

Code Block
ssh -i "my-dev-key.pem" rocky@<management-server-public-ip>

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

Code Block

language	bash

eks-node-cli add -n node-00 -c 1 -m 4096 -p pool-a -r az1 -k xio-standalone

Tip

The new node can be verified using the kubectl command:

Code Block

$

kubectl get node -l eks.amazonaws.com/nodegroup=

x-compute

x-compute

Please ensure ~/.kube/config is set up properly. It takes a couple of minutes for the x-compute node to boot and show up.

The output should display the new nodes as ready:

Code Block
NAME STATUS ROLES AGE VERSION ip-10-0-39-220.us-west-1.x-compute.internal Ready <none> 4m17s v1.29.3-eks-ae9a62a

By default, the EKS token used to access the standalone EKS cluster expired after 60 minutes. Following that, all attempts to access the cluster will fail with Unauthorized errors.

To generate a new EKS token and use it with your existing kubeconfig file, run:

Code Block

language	bash

x-install update-kubeconfig --stack-name=xio-standalone

4. Clean Up

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

Code Block

language	bash

x-install destroy --stack-name xio-standalone

Info

...

In some cases, Terraform might time out during the destroy process.

...

If this happens, simply re-run the command to allow Terraform to reconcile its final state.

...

info

At this time, all controllers and workers EC2 instances need to be manually terminated.

...

Additional Help and Support

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

Code Block
x-install help

...

Versions Compared

Old Version 8

New Version Current

Key

Prerequisites

Installation Steps

1. Create a Standalone Stack

2. Verify Post-Installation Readiness

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

4. Clean Up

Additional Help and Support