A collection of Spectro Cloud tutorials and their respective sample code.
The following tutorial code is available:
- hello-universe-tf - Deploy the Hello Universe application into two Palette Virtual Clusters. Link to the tutorial.
Review the Contribution docs before creating a PR.
- NodeJS v18 or greater.
- Terraform v1.3.0 or greater.
- Terraform-docs
When creating a tutorial folder, ensure you review the following task list:
-
Initialized the repository by issuing the command
make initin the root context. -
Added a README.md file that explains the tutorial code and links to the respective tutorial page.
-
Verified all Terraform variables have helpful descriptions.
-
Formatted all code with proper
fmtcommand such asgo fmt, orterraform fmt. -
If Terrraform, run the following command in the tutorial folder to generate Terrform documentation.
terraform-docs markdown table . >> README.md`
-
Use a semantic release message in the commit message, such as
"fix: your change here", to create a new release. -
Ensure the required education tags are added to Terraform resources.
spectro-cloud-educationapp:<name of app>repository:spectrocloud/tutorials/terraform_managed:true
Example:
variable "tags" { type = list(string) description = "The default tags to apply to Palette resources" default = ["spectro-cloud-education", "app:hello-universe", "repository:spectrocloud/tutorials/", "terraform_managed:true"] }
