Initial commit from template

Author: JMFritz

.gitignore

@@ -0,0 +1,76 @@
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# Node artifact files
+node_modules/
+dist/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[cod]
+__pycache__
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Archive files
+*.zip
+*.tar.*
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+
+# Python virtual env
+.venv/
+
+# Original size images
+*.orig.png
+*.orig.jpg
+
+#Python cache
+__pycache__
+
+# Lab CLI Artifacts
+rendering
+build
+preview
+debug
+
+.vscode
+
+*.auto.tfvars
+*.terraform*
+terraform.tfstate*

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "helpers"]
+	path = helpers
+	url = https://github.com/cloudacademy/labs-cli-helpers.git

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        exclude: template.yaml
+      - id: check-json
+      - id: check-added-large-files
+  - repo: https://github.com/odwyersoftware/brunette
+    rev: 0.2.8
+    hooks:
+      - id: brunette
+        types: [python]
+        files: "steps/"
+  - repo: https://github.com/crate-ci/typos
+    rev: typos-dict-v0.12.4
+    hooks:
+      - id: typos
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: "v1.97.1"
+    hooks:
+      - id: terraform_fmt
+      - id: terraform_tflint
+      - id: terraform_validate
+        args:
+          - --hook-config=--mode=only-check-is-current-lockfile-cross-platform

README.md

@@ -0,0 +1,137 @@
+# Base lab content skeleton
+
+This repo contains a skeleton for lab content. You can fork and use it as a baseline for a new lab.
+
+## How to import in bakery
+
+For the time being Hermione is supporting repos from:
+
+- GitHub
+- BitBucket
+
+to push the content in Bakery you have to call Hermione, our import service, with a webhook,
+specifying the vendor of the repos adding the access token to authenticate the request.
+
+    https://cloudacademy.com/webhooks/hermione/{VENDOR}/?access_token={ACCESS_TOKEN}
+
+### When content is imported on bakery
+
+The content will be imported only when a new tag is pushed:
+
+    git tag v1.0.0
+    git push --tags
+
+### Vendor values:
+
+- github
+- bitbucket
+
+### Access token
+
+For the time being you've to ask the lab team for it.
+
+### Stage
+
+If you want to test the content on stage, just point the webhook to stage:
+
+
+    https://stage.cloudacademy.com/webhooks/hermione/{VENDOR}/?access_token={ACCESS_TOKEN}
+
+### MarkDown version
+
+At the moment is fully supported GitHub Flavored Markdown Spec
+
+   https://github.github.com/gfm/
+
+Under the hood HTML rendering is handled by Python-Markdown with some extension:
+
+   https://python-markdown.github.io/
+
+Thanks to its modularity we could add extensions to handle new cases or custom behaviour.
+
+For example, automatic upload to S3 of the assets is managed by a custom extension.
+
+
+## Repo structure
+
+
+```
+   .
+   +-- config.yaml
+   +-- description.md
+   +-- metadata.yaml
+   +-- assets
+   |   # all assets contained in the lab description
+   |   [...]
+   +-- steps
+   |   +-- 1_lab_step_example
+   |   |   +-- assets
+   |   |   # all assets contained in the lab step
+   |   |   [...]
+   |   |   +-- checks
+   |   |   |   +-- 1_vcf_example
+   |   |   |   |   +-- config.yaml
+   |   |   |   |   +-- description.md
+   |   |   |   |   +-- source.py
+   |   |   |   # all checks order by filesystem
+   |   |   |   [...]
+   |   |   +-- config.yaml
+   |   |   +-- description.md
+   |   |   +-- documentation.md
+   |   # all steps order by filesystem
+   |   [...]
+   +-- environments
+   |   +-- 1_env_example
+   |   |   +-- config.yaml
+   |   |   +-- template.yaml
+   |   |   +-- security_policy
+   |   |   |   +-- config.yaml
+   |   |   |   +-- policy_body.yaml
+   |   # all environments order by filesystem
+   |   [...]
+
+```
+
+## Markdown Syntax Examples
+
+### Test Lab Content
+
+test description with GitHub Flavored Markdown
+
+![](assets/image1.jpg)
+
+- George Washington
+- John Adams
+- Thomas Jefferson
+
+* George Washington
+* John Adams
+* Thomas Jefferson
+
+
+| Syntax      | Description |
+| ----------- | ----------- |
+| Header      | Title       |
+| Paragraph   | Text        |
+
+``` js
+var foo = function (bar) {
+  return bar++;
+};
+
+console.log(foo(5));
+```
+
+
+- [ ] foo
+- [x] bar
+
+Visit www.commonmark.org.
+
+~~Hi~~ Hello, world!
+
+<ins>underline</ins> is accomplished with `ins` html tags
+
+paragraph
+
+    code

assets/warning.png

@@ -0,0 +1,9 @@
+# Checklist
+
+## Validation Checks
+
+- [ ] Can't re-use an existing check
+- [ ] Does not throw exceptions
+- [ ] Is tolerant of student input discrepancies
+- [ ] Timeout appropriate (5s per API call)
+- [ ] Step variables are strings and are cast appropriately

checklist.md

@@ -0,0 +1,31 @@
+title: Lab Test
+slug: lab-test
+short_description: Short description under 160 chars
+lab_features: # cloud-environment|remote-desktop|cli|code-ide
+  - cloud-environment
+duration: 7600
+#step_variables:
+#  - "required_step_var: This <strong>string</strong> will be substituted in lab steps with {LabStep.required_step_var} and available in VCFs."
+#  - "?optional_step_var: Substituted in lab steps with {LabStep.?optional_step_var} and available in VCFs. Optional step variables are not required to be defined in a lab and will be substituted with nothing in that case."
+#  - "template_output: '{{outputName|default:''waiting_for_output''}}'"
+difficulty: Beginner # Beginner|Intermediate|Advanced
+instructor: "Jun Fritz"
+environment_start_image: warning.png # relative to top-level assets/ directory
+environment_end_image: warning.png # relative to top-level assets/ directory
+
+is_challenge: false
+is_assessment: false # at most one of is_challenge and is_assessment may be true
+is_playground: false
+# Challenge lab and lab assessment only properties (when is_challenge: true or lab marked as an assessment)
+#assessed_topics:
+#  - topic1
+#  - topic2
+#audiences: []
+#prerequisites: []
+
+# The following can always be kept at their defaults
+startup_time: 0
+freezable_type: Disabled
+freeze_timeout: 0
+allow_enterprise_bridge: true
+# image: warning.png # relative to top-level assets/ directory

config.yaml

@@ -0,0 +1,36 @@
+What is the topic of the lab? What is good about it?
+
+Why would someone want to learn about the topic? How will they benefit?
+
+What will the student do in the lab?
+
+### Learning objectives
+
+Upon completion of this beginner/intermediate/advanced level lab, you will be able to:
+
+- A specific thing
+- Another specific thing
+- And another
+- Perhaps one more
+
+### Intended audience
+
+- Candidates for CERTIFICATION NAME
+- Cloud Architects
+- Data Engineers
+- DevOps Engineers
+- Machine Learning Engineers
+- Software Engineers
+
+### Prerequisites
+
+Familiarity with the following will be beneficial but is not required:
+
+- A topic
+- Another topic
+- And another
+
+The following content can be used to fulfill the prerequisites:
+
+- [Content Title 1](/lab/lab-slug/)
+- [Content Title 2](/course/course-slug/)

description.md

@@ -0,0 +1,18 @@
+title: Lab Provisioning Block
+description: description
+type: cloud-environment # cloud-environment|remote-desktop|cli|code-ide
+vendor: aws # aws|azure|google|alibaba-cloud vendor is mandatory if type: cloud-environment|remote-desktop
+language: yaml # yaml|json|hcl2
+
+# Tags can be used to specify which subsets of accounts the lab should use to enable access to restricted services
+#tags:
+  #- bedrock
+
+# Needed when type: cli|code-ide
+#workspace_docker_image_url: "421805900968.dkr.ecr.us-east-2.amazonaws.com/cloudacademy/labs-workspace/image-name" # can set tag by appending :tag
+#content_docker_image_name: "github.com/cloudacademy/content-repo"
+#content_docker_image_tag: "tag" # optional; latest used when not specified. Tag will usually be a commit ID
+# Can use 'github.com/cloudacademy/noop-content-image-repo' for the content image if no IDE/CLI checks are required
+
+# Set the size if type: cli|code-ide
+#size: small|medium|large

environments/env1/config.yaml

@@ -0,0 +1,4 @@
+title: Security Policy
+description: descr sec policy 1
+vendor: aws # aws|azure|google|alibaba-cloud
+#custom_policy_tags: # [optional] custom security policy tags (defined in hagrid), string of comma separated values. E.g. azure-vm.mckinsey_instances_count