📄️ About Workloads
Workloads are packages of infrastructure-as-code that can be deployed to one or more AWS accounts from a single location. You can define your AWS resources and Stax will manage the orchestration of deployment, versioning and termination. Once uploaded, Workloads are added to the Catalog, available for other users in your Organization to use, provided they have the required permissions. Stax acts as a buffer between build tools and AWS, ensuring secure deployment of infrastructure.
📄️ Add a Workload to the Workload Catalog
Workloads can be uploaded to the Workload Catalog for anyone within your organization with the right permissions to access. The process involves the creation of a Workload Manifest, which defines what your Workload is. The Workload Manifest is interpreted by Stax, transformed into a Workload and made available within the Workload Catalog.
📄️ Create a Workloads Manifest
A Manifest is a YAML file. Stax interprets the Manifest and deploys whatever is outlined within the Manifest. Stax Workloads utilize AWS CloudFormation for deployment. The Manifest can reference one or more CloudFormation templates which Stax will execute.
📄️ Delete a Workload
Select a running Workload and delete it so that no further AWS resources are consumed, and data and storage are removed, helping you to reduce your AWS costs.
📄️ Deploy a Workload
Once you have uploaded your manifest file and the new Workload Catalog Item becomes available for use, you can now deploy this Workload Catalog Item to any of your Stax-managed AWS accounts, or even to all of them at once.
📄️ How to Protect Stax Workloads
Stax provides protection of both Workloads and the resources Workloads create. Be sure to specify the correct parameters to ensure your Workloads and their resources are appropriately protected.
📄️ Protect Workload Resources
Stax Workloads supports the use of AWS Stack Policies to give you more control and protection over your Stax Workload CloudFormation resources.
📄️ Requirements for a Workloads Assets S3 Bucket
When deploying Workloads, manifest documents will typically require one or more CloudFormation templates to be hosted in an S3 bucket. You can use the built-in stax-deployment-bucket Workload for this purpose, or deploy your own bucket with the details below.
📄️ Update a Workload
Create a new Workload Catalog Item Version when changes are required to an existing Workload Catalog Item. Once the new Workload Catalog Item Version has been created you can update already deployed Workloads to the latest version.
📄️ Workload Name Length Limits
AWS CloudFormation has an overall limit of 128 characters for the name of a stack. Stax adds a 36-character identifier (a UUID) to the CloudFormation stack name. This is to ensure that the stack can be properly assigned against the Workload. This leaves a total of 92 characters for the Workload name and the manifest resource name (which includes the joining hyphens).
📄️ Workload Parameters
Stax Workloads utilizes parameters that can be passed to Cloudformation templates. There are different parameters that can be manually specified or Stax default parameters which get passed at the time of deployment. On this page we will go through each type of parameter supported by Stax Workloads and how they can be used.