{"type":"doc","content":[{"type":"paragraph","content":[{"text":" The ","type":"text"},{"text":"terraform-exostellar-modules","type":"text","marks":[{"type":"code"}]},{"text":" are one of the newest Exostellar installation approaches designed to simplify the setup process.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"paragraph","content":[{"text":"Before running the Terraform commands on ","type":"text"},{"text":"terraform-exostellar-modules","type":"text","marks":[{"type":"code"}]},{"text":", ensure that your environment meets the following requirements:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Terraform","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://developer.hashicorp.com/terraform/install"}}]},{"text":": Version 1.8+","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Helm","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://helm.sh/docs/intro/install/"}}]},{"text":": Version 3.14.2+","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AWS CLI","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-install.html"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AWS Authentication, Credentials, and Region","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Please properly configure AWS authentication and default region in your local environment.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"AWS Authentication and Credentials Setup Methods"},"content":[{"type":"paragraph","content":[{"text":"You can set up credentials using various methods such as command-line options, environment variables, assume role, credentials files, configuration files, etc.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Command-line Options","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"aws configure sso","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"aws s3 ls --profile profile1","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Environment Variables","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"export AWS_ACCESS_KEY_ID=\nexport AWS_SECRET_ACCESS_KEY=\nexport AWS_SESSION_TOKEN=","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Assume role","type":"text"}]},{"type":"codeBlock","content":[{"text":"aws sts assume-role \\\n --role-arn arn:aws:iam::123456789012:role/xaccounts3access \\\n --role-session-name s3-access-example","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Credentials and Configuration File: ","type":"text"},{"type":"hardBreak"},{"text":"Update in ","type":"text"},{"text":"~/.aws/credentials","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"~/.aws/config","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"aws configure","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Please ensure the default region is set for deployment. If not set above, use the following command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"aws configure set default.region us-east-2","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":" Ensure the account has the following IAM permissions:","type":"text"}]},{"type":"expand","attrs":{"title":"IAM Permissions for the AWS Account - Standalone Flow"},"content":[{"type":"paragraph","content":[{"text":"When working with the standalone flow, i.e., deploying everything from scratch using the ","type":"text"},{"text":"examples/standalone-flow","type":"text","marks":[{"type":"code"}]},{"text":" module, use the following IAM policy. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please add your AWS account ID and cluster name to the policy below.","type":"text"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n\t\"Version\": \"2012-10-17\",\n\t\"Statement\": [\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"iam:PassRole\"\n\t\t\t],\n\t\t\t\"Resource\": [\n\t\t\t\t\"arn:aws:iam:::role/*\",\n\t\t\t\t\"arn:aws:iam:::role/terraform-*\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"autoscaling:CompleteLifecycleAction\",\n\t\t\t\t\"autoscaling:CreateAutoScalingGroup\",\n\t\t\t\t\"autoscaling:DeleteAutoScalingGroup\",\n\t\t\t\t\"autoscaling:EnableMetricsCollection\",\n\t\t\t\t\"autoscaling:PutNotificationConfiguration\",\n\t\t\t\t\"autoscaling:UpdateAutoScalingGroup\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"ec2:AllocateAddress\",\n\t\t\t\t\"ec2:AssignPrivateIpAddresses\",\n\t\t\t\t\"ec2:AssociateRouteTable\",\n\t\t\t\t\"ec2:AttachInternetGateway\",\n\t\t\t\t\"ec2:AttachNetworkInterface\",\n\t\t\t\t\"ec2:AuthorizeSecurityGroupEgress\",\n\t\t\t\t\"ec2:AuthorizeSecurityGroupIngress\",\n\t\t\t\t\"ec2:CreateFleet\",\n\t\t\t\t\"ec2:CreateInternetGateway\",\n\t\t\t\t\"ec2:CreateLaunchTemplate\",\n\t\t\t\t\"ec2:CreateLaunchTemplateVersion\",\n\t\t\t\t\"ec2:CreateNatGateway\",\n\t\t\t\t\"ec2:CreateNetworkAclEntry\",\n\t\t\t\t\"ec2:CreateNetworkInterface\",\n\t\t\t\t\"ec2:CreateNetworkInterfacePermission\",\n\t\t\t\t\"ec2:CreateRoute\",\n\t\t\t\t\"ec2:CreateRouteTable\",\n\t\t\t\t\"ec2:CreateSecurityGroup\",\n\t\t\t\t\"ec2:CreateSubnet\",\n\t\t\t\t\"ec2:CreateTags\",\n\t\t\t\t\"ec2:CreateVpc\",\n\t\t\t\t\"ec2:DeleteInternetGateway\",\n\t\t\t\t\"ec2:DeleteLaunchTemplate\",\n\t\t\t\t\"ec2:DeleteNatGateway\",\n\t\t\t\t\"ec2:DeleteNetworkAclEntry\",\n\t\t\t\t\"ec2:DeleteNetworkInterface\",\n\t\t\t\t\"ec2:DeleteRoute\",\n\t\t\t\t\"ec2:DeleteRouteTable\",\n\t\t\t\t\"ec2:DeleteSecurityGroup\",\n\t\t\t\t\"ec2:DeleteSubnet\",\n\t\t\t\t\"ec2:DeleteTags\",\n\t\t\t\t\"ec2:DeleteVpc\",\n\t\t\t\t\"ec2:DescribeAddresses\",\n\t\t\t\t\"ec2:DescribeAddressesAttribute\",\n\t\t\t\t\"ec2:DescribeAvailabilityZones\",\n\t\t\t\t\"ec2:DescribeDhcpOptions\",\n\t\t\t\t\"ec2:DescribeImages\",\n\t\t\t\t\"ec2:DescribeInstanceAttribute\",\n\t\t\t\t\"ec2:DescribeInstances\",\n\t\t\t\t\"ec2:DescribeInstanceTypes\",\n\t\t\t\t\"ec2:DescribeInternetGateways\",\n\t\t\t\t\"ec2:DescribeKeyPairs\",\n\t\t\t\t\"ec2:DescribeLaunchTemplates\",\n\t\t\t\t\"ec2:DescribeLaunchTemplateVersions\",\n\t\t\t\t\"ec2:DescribeNatGateways\",\n\t\t\t\t\"ec2:DescribeNetworkAcls\",\n\t\t\t\t\"ec2:DescribeNetworkInterfaces\",\n\t\t\t\t\"ec2:DescribeRouteTables\",\n\t\t\t\t\"ec2:DescribeSecurityGroupRules\",\n\t\t\t\t\"ec2:DescribeSecurityGroups\",\n\t\t\t\t\"ec2:DescribeSnapshots\",\n\t\t\t\t\"ec2:DescribeSubnets\",\n\t\t\t\t\"ec2:DescribeTags\",\n\t\t\t\t\"ec2:DescribeVolumes\",\n\t\t\t\t\"ec2:DescribeVpcAttribute\",\n\t\t\t\t\"ec2:DescribeVpcs\",\n\t\t\t\t\"ec2:DetachInternetGateway\",\n\t\t\t\t\"ec2:DetachNetworkInterface\",\n\t\t\t\t\"ec2:DisassociateAddress\",\n\t\t\t\t\"ec2:DisassociateRouteTable\",\n\t\t\t\t\"ec2:ModifyInstanceAttribute\",\n\t\t\t\t\"ec2:ModifyLaunchTemplate\",\n\t\t\t\t\"ec2:ModifyNetworkInterfaceAttribute\",\n\t\t\t\t\"ec2:ModifySubnetAttribute\",\n\t\t\t\t\"ec2:ModifyVpcAttribute\",\n\t\t\t\t\"ec2:ReleaseAddress\",\n\t\t\t\t\"ec2:RevokeSecurityGroupEgress\",\n\t\t\t\t\"ec2:RevokeSecurityGroupIngress\",\n\t\t\t\t\"ec2:RunInstances\",\n\t\t\t\t\"ec2:TerminateInstances\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"eks:AssociateAccessPolicy\",\n\t\t\t\t\"eks:CreateAccessEntry\",\n\t\t\t\t\"eks:CreateAddon\",\n\t\t\t\t\"eks:CreateCluster\",\n\t\t\t\t\"eks:CreateNodegroup\",\n\t\t\t\t\"eks:DeleteAccessEntry\",\n\t\t\t\t\"eks:DeleteAddon\",\n\t\t\t\t\"eks:DeleteCluster\",\n\t\t\t\t\"eks:DeleteNodegroup\",\n\t\t\t\t\"eks:DescribeAccessEntry\",\n\t\t\t\t\"eks:DescribeAddon\",\n\t\t\t\t\"eks:DescribeAddonVersions\",\n\t\t\t\t\"eks:DescribeCluster\",\n\t\t\t\t\"eks:DescribeNodegroup\",\n\t\t\t\t\"eks:DisassociateAccessPolicy\",\n\t\t\t\t\"eks:ListAssociatedAccessPolicies\",\n\t\t\t\t\"eks:ListNodegroups\",\n\t\t\t\t\"eks:TagResource\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"events:PutRule\",\n\t\t\t\t\"events:PutTargets\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"iam:AddRoleToInstanceProfile\",\n\t\t\t\t\"iam:AttachRolePolicy\",\n\t\t\t\t\"iam:CreateInstanceProfile\",\n\t\t\t\t\"iam:CreateOpenIDConnectProvider\",\n\t\t\t\t\"iam:CreatePolicy\",\n\t\t\t\t\"iam:CreateRole\",\n\t\t\t\t\"iam:DeleteInstanceProfile\",\n\t\t\t\t\"iam:DeleteOpenIDConnectProvider\",\n\t\t\t\t\"iam:DeletePolicy\",\n\t\t\t\t\"iam:DeleteRole\",\n\t\t\t\t\"iam:DeleteRolePolicy\",\n\t\t\t\t\"iam:DetachRolePolicy\",\n\t\t\t\t\"iam:GetInstanceProfile\",\n\t\t\t\t\"iam:GetOpenIDConnectProvider\",\n\t\t\t\t\"iam:GetPolicy\",\n\t\t\t\t\"iam:GetPolicyVersion\",\n\t\t\t\t\"iam:GetRole\",\n\t\t\t\t\"iam:GetRolePolicy\",\n\t\t\t\t\"iam:ListAttachedRolePolicies\",\n\t\t\t\t\"iam:ListInstanceProfilesForRole\",\n\t\t\t\t\"iam:ListPolicyVersions\",\n\t\t\t\t\"iam:ListRolePolicies\",\n\t\t\t\t\"iam:PutRolePolicy\",\n\t\t\t\t\"iam:RemoveRoleFromInstanceProfile\",\n\t\t\t\t\"iam:TagInstanceProfile\",\n\t\t\t\t\"iam:TagOpenIDConnectProvider\",\n\t\t\t\t\"iam:TagPolicy\",\n\t\t\t\t\"iam:TagRole\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"kms:CreateAlias\",\n\t\t\t\t\"kms:CreateGrant\",\n\t\t\t\t\"kms:CreateKey\",\n\t\t\t\t\"kms:DeleteAlias\",\n\t\t\t\t\"kms:DescribeKey\",\n\t\t\t\t\"kms:EnableKeyRotation\",\n\t\t\t\t\"kms:GetKeyPolicy\",\n\t\t\t\t\"kms:GetKeyRotationStatus\",\n\t\t\t\t\"kms:ListAliases\",\n\t\t\t\t\"kms:ListResourceTags\",\n\t\t\t\t\"kms:PutKeyPolicy\",\n\t\t\t\t\"kms:RetireGrant\",\n\t\t\t\t\"kms:ScheduleKeyDeletion\",\n\t\t\t\t\"kms:TagResource\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"logs:CreateLogGroup\",\n\t\t\t\t\"logs:CreateLogStream\",\n\t\t\t\t\"logs:DeleteLogGroup\",\n\t\t\t\t\"logs:DescribeLogGroups\",\n\t\t\t\t\"logs:ListTagsForResource\",\n\t\t\t\t\"logs:PutRetentionPolicy\",\n\t\t\t\t\"logs:TagResource\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"aws-marketplace:ListEntities\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"s3:GetObject\",\n\t\t\t\t\"s3:ListBucket\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"ssm:RegisterManagedInstance\",\n\t\t\t\t\"ssm:UpdateInstanceInformation\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t}\n\t]\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"IAM Permissions for the AWS Account - Using an Existing Cluster"},"content":[{"type":"paragraph","content":[{"text":"When working with existing EKS clusters, use the following IAM policy.","type":"text"}]},{"type":"paragraph","content":[{"text":"When working with the existing cluster flow, i.e., deploying the Exostellar setup using the ","type":"text"},{"text":"examples/existing-cluster-flow","type":"text","marks":[{"type":"code"}]},{"text":" module on top of an existing cluster, use the following IAM policy.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please add your AWS account ID and cluster name to the policy below.","type":"text"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n\t\"Version\": \"2012-10-17\",\n\t\"Statement\": [\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"iam:PassRole\"\n\t\t\t],\n\t\t\t\"Resource\": [\n\t\t\t\t\"arn:aws:iam:::role/*\",\n\t\t\t\t\"arn:aws:iam:::role/terraform-*\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"aws-marketplace:ListEntities\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"ec2:AuthorizeSecurityGroupEgress\",\n\t\t\t\t\"ec2:AuthorizeSecurityGroupIngress\",\n\t\t\t\t\"ec2:CreateSecurityGroup\",\n\t\t\t\t\"ec2:CreateTags\",\n\t\t\t\t\"ec2:DeleteSecurityGroup\",\n\t\t\t\t\"ec2:DescribeDhcpOptions\",\n\t\t\t\t\"ec2:DescribeImages\",\n\t\t\t\t\"ec2:DescribeInstanceAttribute\",\n\t\t\t\t\"ec2:DescribeInstances\",\n\t\t\t\t\"ec2:DescribeInstanceTypes\",\n\t\t\t\t\"ec2:DescribeInternetGateways\",\n\t\t\t\t\"ec2:DescribeNatGateways\",\n\t\t\t\t\"ec2:DescribeNetworkInterfaces\",\n\t\t\t\t\"ec2:DescribeRouteTables\",\n\t\t\t\t\"ec2:DescribeSecurityGroups\",\n\t\t\t\t\"ec2:DescribeSnapshots\",\n\t\t\t\t\"ec2:DescribeSubnets\",\n\t\t\t\t\"ec2:DescribeTags\",\n\t\t\t\t\"ec2:DescribeVolumes\",\n\t\t\t\t\"ec2:DescribeVpcAttribute\",\n\t\t\t\t\"ec2:DescribeVpcs\",\n\t\t\t\t\"ec2:ModifyInstanceAttribute\",\n\t\t\t\t\"ec2:RevokeSecurityGroupEgress\",\n\t\t\t\t\"ec2:RunInstances\",\n\t\t\t\t\"ec2:TerminateInstances\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"eks:DescribeCluster\",\n\t\t\t\t\"eks:DescribeNodegroup\",\n\t\t\t\t\"eks:ListNodegroups\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"iam:AddRoleToInstanceProfile\",\n\t\t\t\t\"iam:AttachRolePolicy\",\n\t\t\t\t\"iam:CreateInstanceProfile\",\n\t\t\t\t\"iam:CreateRole\",\n\t\t\t\t\"iam:DeleteInstanceProfile\",\n\t\t\t\t\"iam:DeleteRole\",\n\t\t\t\t\"iam:DeleteRolePolicy\",\n\t\t\t\t\"iam:DetachRolePolicy\",\n\t\t\t\t\"iam:GetInstanceProfile\",\n\t\t\t\t\"iam:GetPolicy\",\n\t\t\t\t\"iam:GetPolicyVersion\",\n\t\t\t\t\"iam:GetRole\",\n\t\t\t\t\"iam:GetRolePolicy\",\n\t\t\t\t\"iam:ListAttachedRolePolicies\",\n\t\t\t\t\"iam:ListInstanceProfilesForRole\",\n\t\t\t\t\"iam:ListRolePolicies\",\n\t\t\t\t\"iam:PutRolePolicy\",\n\t\t\t\t\"iam:RemoveRoleFromInstanceProfile\",\n\t\t\t\t\"iam:TagInstanceProfile\",\n\t\t\t\t\"iam:TagRole\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t},\n\t\t{\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Action\": [\n\t\t\t\t\"s3:GetObject\",\n\t\t\t\t\"s3:ListBucket\"\n\t\t\t],\n\t\t\t\"Resource\": \"*\"\n\t\t}\n\t]\n}","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Valid AWS Marketplace Subscriptions ","type":"text","marks":[{"type":"strong"}]},{"text":"for ","type":"text"},{"text":"Exostellar Management Server","type":"text","marks":[{"type":"link","attrs":{"href":"https://aws.amazon.com/marketplace/pp/prodview-zs6gqedkfppto?applicationId=AWSMPContessa&ref_=beagle&sr=0-1"}}]},{"text":", ","type":"text"},{"text":"Exostellar Controller","type":"text","marks":[{"type":"link","attrs":{"href":"https://aws.amazon.com/marketplace/pp/prodview-x7vashj5vkg42?sr=0-2&ref_=beagle&applicationId=AWSMPContessa"}}]},{"text":", ","type":"text"},{"text":"Exostellar Worker","type":"text","marks":[{"type":"link","attrs":{"href":"https://aws.amazon.com/marketplace/pp/prodview-qljpfa5p6g5sg?sr=0-3&ref_=beagle&applicationId=AWSMPContessa"}}]},{"text":" AMIs for the same AWS account","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SSH Key","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"expand","attrs":{"title":"SSH Key Creation"},"content":[{"type":"paragraph","content":[{"text":"Use the following command to create a new SSH key pair:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"aws ec2 create-key-pair --key-name 'my-dev-key' --query 'KeyMaterial' --output text --region us-east-2 > my-dev-key.pem","type":"text"}]},{"type":"paragraph","content":[{"text":"Modify the permission to secure the key:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"chmod 400 my-dev-key.pem","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"terraform-exostellar-modules","type":"text","marks":[{"type":"code"}]},{"text":": v0.0.1+","type":"text"},{"type":"hardBreak"},{"type":"mediaInline","attrs":{"id":"ef3c38c1-9c2c-42c2-b7bf-f5fa4e5e8004","collection":"contentId-431390721"}},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"Download, extract, and open a terminal from inside the extracted directory to proceed with the next steps in this doc. You should see the following examples, modules, scripts, and the README.","type":"text"}]},{"type":"codeBlock","content":[{"text":"├── examples/\n│ ├── existing-cluster-flow/\n│ └── standalone-flow/\n├── modules/\n│ ├── ems/\n│ ├── existing-cluster-full/\n│ ├── iam/\n│ ├── infra/\n│ ├── karpenter/\n│ └── standalone-full/\n├── scripts/\n└── README.md","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Installation Steps","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Creating a Sandbox EKS Cluster and Deploying the Management Server","type":"text"}]},{"type":"paragraph","content":[{"text":"If you'd like to deploy a full Exostellar setup from scratch—including:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A new EKS cluster","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Controllers and Workers IAMs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Exostellar Management Server (EMS)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Exostellar’s Karpenter (","type":"text"},{"text":"exokarpenter","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Use the example module located at:","type":"text"},{"text":"examples/standalone-flow/","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Step 1: Configure the Terraform Module","type":"text"}]},{"type":"paragraph","content":[{"text":"Open ","type":"text"},{"text":"examples/standalone-flow/main.tf","type":"text","marks":[{"type":"code"}]},{"text":" and update the necessary values:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"93caffd4-ee12-428f-b75b-f1ff4ffd6130"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"Variable","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Infrastructure-related resources","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"eks_cluster","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the EKS Cluster to be created.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"aws_region","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"AWS region where the cluster is deployed. Default: ","type":"text"},{"text":"us-east-1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"eks_version","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"EKS (Kubernetes) version. Default: ","type":"text"},{"text":"1.31","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"vpc_cidr","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"CIDR block for VPC to be created for EKS Cluster.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Exostellar Management Server (EMS) configurations","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ssh_key_name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Name of an existing SSH key pair in AWS (only the key-pair ","type":"text"},{"text":"resource name","type":"text","marks":[{"type":"em"}]},{"text":", not the local file name).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_ami_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"AMI ID for Exostellar Management Server. Must match the selected ","type":"text"},{"text":"aws_region","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_instance_type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"EC2 instance type for EMS. Default: ","type":"text"},{"text":"m5d.xlarge","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_volume_size_gb","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"EMS volume size in GB. Default: ","type":"text"},{"text":"100","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_termination_protection","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Whether to enable termination protection on the EMS instance. Default: ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"profile_availability_zone","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Profile's availability zone. Must match the selected ","type":"text"},{"text":"aws_region","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Controller and Worker configurations","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"xspot_enable_hyperthreading","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Enable hyperthreading. Default: ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"xspot_enable_balloon","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Enable self-ballooning. Default: ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Exostellar Karpenter configurations","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"xkarpenter_version","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"xKarpenter's version. Default is v","type":"text"},{"text":"2.0.1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Step 2: Deploy with Terraform","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Run the Terraform commands to deploy the standalone-flow’s stack:","type":"text"}]},{"type":"codeBlock","content":[{"text":"terraform -chdir=./examples/standalone-flow init\nterraform -chdir=./examples/standalone-flow plan -input=false\nterraform -chdir=./examples/standalone-flow apply -auto-approve","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note:","type":"text","marks":[{"type":"strong"}]},{"text":" Terraform commands are idempotent. You can re-run them safely to retry failed operations or refresh the state.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Exostellar Management Server Console Access","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"URL:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"https://","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Username:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"exostellar_management_server_console_admin_username","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Password:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"exostellar_management_server_console_admin_password","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Exostellar Management Server SSH Access","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"ssh -i rocky@","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"rocky","type":"text","marks":[{"type":"code"}]},{"text":" is the username for the RockyLinux VM, on which EMS is built.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SSH private key is the private key corresponding to ","type":"text"},{"text":"ssh_key_name","type":"text","marks":[{"type":"code"}]},{"text":" specified as input without file extension.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Deploying the Management Server into an Existing EKS Cluster","type":"text"}]},{"type":"paragraph","content":[{"text":"If you already have an Amazon EKS cluster running and want to deploy the Exostellar setup on top of it—including the following components:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Controller and Worker IAM roles","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Exostellar Management Server (EMS)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Exostellar’s Karpenter (exokarpenter)","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Use the example module provided at ","type":"text"},{"text":"examples/existing-cluster-flow","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Step 1: Configure ","type":"text","marks":[{"type":"strong"}]},{"text":"main.tf","type":"text","marks":[{"type":"code"}]},{"text":" for Your Environment","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"Edit the following variables in ","type":"text"},{"text":"examples/existing-cluster-flow/main.tf","type":"text","marks":[{"type":"code"}]},{"text":" according to your setup:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"51a332e1-954e-442f-ab29-97c934428646"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"Variable","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Infrastructure-related resources","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"eks_cluster","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Name of your existing EKS cluster.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"aws_region","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"AWS region where the cluster is deployed. Default: ","type":"text"},{"text":"us-east-1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"eks_version","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Kubernetes version of your EKS cluster. Default: ","type":"text"},{"text":"1.31","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"vpc_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"VPC ID associated with the EKS cluster.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Exostellar Management Server (EMS) configurations","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ssh_key_name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Name of an existing SSH key pair in AWS (only the key-pair ","type":"text"},{"text":"resource name","type":"text","marks":[{"type":"em"}]},{"text":", not the local file name).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"public_subnet_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Public subnet ID from the same VPC (identified via ","type":"text"},{"text":"vpc_id","type":"text","marks":[{"type":"code"}]},{"text":"). This is used to expose EMS to the internet.","type":"text"},{"type":"hardBreak"},{"text":"Note:","type":"text","marks":[{"type":"strong"}]},{"text":" Must be in the same Availability Zone as ","type":"text"},{"text":"private_subnet_id","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"profile_availability_zone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"profile_availability_zone","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Exostellar profile's availability zone. Default is us-east-1a.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_ami_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"AMI ID for Exostellar Management Server. Must match the selected ","type":"text"},{"text":"aws_region","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_instance_type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"EC2 instance type for EMS. Default: ","type":"text"},{"text":"m5d.xlarge","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_volume_size_gb","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"EMS volume size in GB. Default: ","type":"text"},{"text":"100","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_termination_protection","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Whether to enable termination protection on the EMS instance. Default: ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"ems_security_group_ids","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"A list of security group IDs. Must include:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The EKS cluster security group (not the default one)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The node security group","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Include others as needed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Controller and Worker configurations","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"xspot_enable_hyperthreading","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Enable hyperthreading. Default: ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"xspot_enable_balloon","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"Enable self-ballooning. Default: ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"private_subnet_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"The ID of the private subnet from the VPC (specified using ","type":"text"},{"text":"vpc_id","type":"text","marks":[{"type":"code"}]},{"text":") associated with the existing EKS cluster. EMS will use this subnet to communicate internally with Controllers and Workers.","type":"text"},{"type":"hardBreak"},{"text":"Note:","type":"text","marks":[{"type":"strong"}]},{"text":" Must be in the same AZ as specified in ","type":"text"},{"text":"profile_availability_zone","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[265.0,492.0]},"content":[{"type":"paragraph","content":[{"text":"Exostellar Karpenter configurations","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[265.0]},"content":[{"type":"paragraph","content":[{"text":"xkarpenter_version","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[492.0]},"content":[{"type":"paragraph","content":[{"text":"xKarpenter's version. Default is v","type":"text"},{"text":"2.0.1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Step 2: Deploy Using Terraform","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Run the Terraform commands to deploy the existing-cluster-flow’s stack:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"terraform -chdir=./examples/existing-cluster-flow init\nterraform -chdir=./examples/existing-cluster-flow plan -input=false\nterraform -chdir=./examples/existing-cluster-flow apply -auto-approve","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note:","type":"text","marks":[{"type":"strong"}]},{"text":" Terraform commands are idempotent. You can re-run them safely to retry failed operations or refresh the state.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Output on Successful Deployment","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"You will see output similar to the following:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"eks_cluster = \"xio-standalone\"\nenvironment = \"k8s\"\nexostellar_management_server_console_admin_password = \"xxxxxxxx\"\nexostellar_management_server_console_admin_username = \"admin@xxxx\"\nexostellar_management_server_private_ip = \"10.0.141.xx\"\nexostellar_management_server_public_ip = \"52.53.171.x\"\nxkarpenter_namespace = \"exokarpenter\"\nxkarpenter_version = \"v2.0.1\"\nxspot_controller_instance_profile_arn = \"arn:aws:iam::97709900xxxx:instance-profile/xio-standalone-xspot-controller\"\nxspot_controller_role_arn = \"arn:aws:iam::97709900xxxx:role/xio-standalone-xspot-controller\"\nxspot_worker_instance_profile_arn = \"arn:aws:iam::97709900xxxx:instance-profile/xio-standalone-xspot-worker\"\nxspot_worker_role_arn = \"arn:aws:iam::97709900xxxx:role/xio-standalone-xspot-worker\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Exostellar Management Server Console Access","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"URL:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"https://","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Username:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"exostellar_management_server_console_admin_username","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Password:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"exostellar_management_server_console_admin_password","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Exostellar Management Server SSH Access","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"ssh -i rocky@","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"rocky","type":"text","marks":[{"type":"code"}]},{"text":" is the username for the RockyLinux VM, on which EMS is built.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SSH private key is the private key corresponding to ","type":"text"},{"text":"ssh_key_name","type":"text","marks":[{"type":"code"}]},{"text":" specified as input without file extension.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Cleaning Up","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Standalone Flow","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To remove all resources created by the ","type":"text"},{"text":"standalone-flow","type":"text","marks":[{"type":"code"}]},{"text":" module—including the EKS cluster, Controller and Worker IAM roles, EMS, and exokarpenter — run:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"terraform -chdir=./examples/standalone-flow destroy -auto-approve -refresh=true","type":"text"}]},{"type":"paragraph","content":[{"text":"This will ","type":"text"},{"text":"completely tear down","type":"text","marks":[{"type":"strong"}]},{"text":" the deployed infrastructure.","type":"text"}]},{"type":"paragraph","content":[{"text":"Existing Cluster Flow","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To clean up everything deployed except the EKS cluster (which was pre-existing), run the following:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"terraform -chdir=./examples/existing-cluster-flow destroy -auto-approve -refresh=true","type":"text"}]},{"type":"paragraph","content":[{"text":"This will delete the Controller and Worker IAM roles, EMS instance, and exokarpenter components—while ","type":"text"},{"text":"preserving your original EKS cluster","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Additional Help and Support","type":"text"}]},{"type":"paragraph","content":[{"text":"For more configuration options, variables, and usage examples, refer to the relevant ","type":"text"},{"text":"README.md","type":"text","marks":[{"type":"code"}]},{"text":" files located throughout the repository:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"├── examples/\n│ ├── existing-cluster-flow/\n│ │ └── README.md\n│ └── standalone-flow/\n│ └── README.md\n├── modules/\n│ ├── ems/\n│ │ └── README.md\n│ ├── existing-cluster-full/\n│ │ └── README.md\n│ ├── iam/\n│ │ └── README.md\n│ ├── infra/\n│ │ └── README.md\n│ ├── karpenter/\n│ │ └── README.md\n│ └── standalone-full/\n│ └── README.md\n└── README.md","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"If you run into any issues:","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Capture as much terminal output as possible.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Compress the entire repository directory (including hidden files) using ","type":"text"},{"text":".zip","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":".tar","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Submit the archive along with a description of your issue to ","type":"text"},{"text":"Exostellar Customer Support","type":"text","marks":[{"type":"link","attrs":{"href":"https://customer.support.exostellar.io/servicedesk/customer/portal/3/group/4/create/17"}}]},{"text":".","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Our team will assist you in troubleshooting and resolving the issue promptly.","type":"text"}]}]},{"type":"paragraph"}],"version":1}