Merge pull request #1 from treebeardtech/dev-0.1

Dev 0.1

Author: alex-treebeard

.devcontainer/Dockerfile

@@ -14,5 +14,7 @@ ENV DEBIAN_FRONTEND=noninteractive
 RUN sudo apt-get update -y && sudo apt-get install -y \
   iputils-ping \
   traceroute \
-  kmod
-ENV PATH="/home/vscode/.local/bin/:$PATH"
+  kmod \
+  vim
+  ENV PATH="/home/vscode/.local/bin/:$PATH"
+ENV EDITOR=vim

.devcontainer/devcontainer.json

@@ -26,40 +26,16 @@
       "NODE_VERSION": "18.7"
     }
   },
-  "runArgs": [ // maybe remove this
-    "--network=host",
-  ],
   "features": {
-    "ghcr.io/devcontainers-contrib/features/cloudflared:1": {},
-    "ghcr.io/devcontainers/features/go:1": {
-    },
-    "ghcr.io/devcontainers/features/aws-cli": {
-      "version": "2.6.3"
-    },
-    "ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {
-      "omzPlugins": "zsh-syntax-highlighting zsh-autosuggestions"
-    },
-    "ghcr.io/devcontainers-contrib/features/starship-homebrew:1": {},
-    "ghcr.io/devcontainers-contrib/features/aws-cdk:2": {
-      "version": "2.59.0"
-    },
-    "ghcr.io/devcontainers/features/azure-cli:1": {},
     "ghcr.io/devcontainers/features/terraform:1": {
       "version": "1.6.2"
     },
     "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
     "ghcr.io/devcontainers-contrib/features/kind:1": {},
-    "ghcr.io/devcontainers-contrib/features/packer-asdf:2": {},
     "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {
       "version": "1.25.6"
     },
     "ghcr.io/rio/features/k3d:1": {},
-    // "ghcr.io/devcontainers/features/nix:1": {},
-    "ghcr.io/devcontainers-contrib/features/infracost:1": {
-      "version": "0.10.30"
-    },
-    "ghcr.io/dhoeric/features/google-cloud-cli:1": {
-    },
     "ghcr.io/devcontainers-contrib/features/terraform-docs:1": {
     },
     "ghcr.io/devcontainers/features/github-cli:1": {
@@ -68,21 +44,23 @@
     },
     "ghcr.io/devcontainers-contrib/features/istioctl:1": {
     },
+    "ghcr.io/devcontainers-contrib/features/argo-cd:1": {
+    },
   },
   "mounts": [
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached",
     // "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zsh_history,target=/home/vscode/.zsh_history,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zshrc,target=/home/vscode/.zshrc,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zshenv,target=/home/vscode/.zshenv,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.terraform.d,target=/home/vscode/.terraform.d,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.azure,target=/home/vscode/.azure,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/infracost,target=/home/vscode/.config/infracost,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/gcloud,target=/home/vscode/.config/gcloud,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/starship.toml,target=/home/vscode/.config/starship.toml,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.kube,target=/home/vscode/.kube,type=bind,consistency=cached",
-    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.gitconfig,target=/home/vscode/.gitconfig,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zsh_history,target=/home/vscode/.zsh_history,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zshrc,target=/home/vscode/.zshrc,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zshenv,target=/home/vscode/.zshenv,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.terraform.d,target=/home/vscode/.terraform.d,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.azure,target=/home/vscode/.azure,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/infracost,target=/home/vscode/.config/infracost,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/gcloud,target=/home/vscode/.config/gcloud,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/starship.toml,target=/home/vscode/.config/starship.toml,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.kube,target=/home/vscode/.kube,type=bind,consistency=cached",
+    // "source=${localEnv:HOME}${localEnv:USERPROFILE}/.gitconfig,target=/home/vscode/.gitconfig,type=bind,consistency=cached",
   ]
 }

.devcontainer/vm/Dockerfile

@@ -0,0 +1,20 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.148.1/containers/python-3/.devcontainer/base.Dockerfile
+ARG VARIANT="3.11"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} as devcontainer
+ARG INSTALL_NODE="true"
+ARG NODE_VERSION="lts/*"
+RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+USER vscode
+RUN pip3 --disable-pip-version-check --no-cache-dir install -U \
+  'poetry==1.6.1' \
+  'pre-commit==3.6.0' \
+  'pip==23.2.1'
+RUN npm install -g @devcontainers/[email protected]
+ENV DEBIAN_FRONTEND=noninteractive
+RUN sudo apt-get update -y && sudo apt-get install -y \
+  iputils-ping \
+  traceroute \
+  kmod \
+  vim
+  ENV PATH="/home/vscode/.local/bin/:$PATH"
+ENV EDITOR=vim

.devcontainer/vm/devcontainer.json

@@ -0,0 +1,90 @@
+{
+  "postCreateCommand": "make post-create",
+  "postStartCommand": "make post-start",
+  "remoteUser": "vscode",
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "zsh",
+        "python.pythonPath": "/usr/local/bin/python"
+      },
+      "extensions": [
+        "ms-python.python",
+        "mutantdino.resourcemonitor",
+        "github.copilot",
+        "github.copilot-chat"
+      ]
+    }
+  },
+  "build": {
+    "dockerfile": "Dockerfile",
+    "target": "devcontainer",
+    "context": "..",
+    "args": {
+      "VARIANT": "3.11",
+      "INSTALL_NODE": "true",
+      "NODE_VERSION": "18.7"
+    }
+  },
+  "runArgs": [ // maybe remove this
+    "--network=host",
+  ],
+  "features": {
+    "ghcr.io/devcontainers-contrib/features/cloudflared:1": {},
+    "ghcr.io/devcontainers/features/go:1": {
+    },
+    "ghcr.io/devcontainers/features/aws-cli": {
+      "version": "2.6.3"
+    },
+    "ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {
+      "omzPlugins": "zsh-syntax-highlighting zsh-autosuggestions"
+    },
+    "ghcr.io/devcontainers-contrib/features/starship-homebrew:1": {},
+    "ghcr.io/devcontainers-contrib/features/aws-cdk:2": {
+      "version": "2.59.0"
+    },
+    "ghcr.io/devcontainers/features/azure-cli:1": {},
+    "ghcr.io/devcontainers/features/terraform:1": {
+      "version": "1.6.2"
+    },
+    "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
+    "ghcr.io/devcontainers-contrib/features/kind:1": {},
+    "ghcr.io/devcontainers-contrib/features/packer-asdf:2": {},
+    "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {
+      "version": "1.25.6"
+    },
+    "ghcr.io/rio/features/k3d:1": {},
+    // "ghcr.io/devcontainers/features/nix:1": {},
+    "ghcr.io/devcontainers-contrib/features/infracost:1": {
+      "version": "0.10.30"
+    },
+    "ghcr.io/dhoeric/features/google-cloud-cli:1": {
+    },
+    "ghcr.io/devcontainers-contrib/features/terraform-docs:1": {
+    },
+    "ghcr.io/devcontainers/features/github-cli:1": {
+    },
+    "ghcr.io/rio/features/k9s:1": {
+    },
+    "ghcr.io/devcontainers-contrib/features/istioctl:1": {
+    },
+    "ghcr.io/devcontainers-contrib/features/argo-cd:1": {
+    },
+  },
+  "mounts": [
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached",
+    // "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zsh_history,target=/home/vscode/.zsh_history,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zshrc,target=/home/vscode/.zshrc,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.zshenv,target=/home/vscode/.zshenv,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.terraform.d,target=/home/vscode/.terraform.d,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.azure,target=/home/vscode/.azure,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/infracost,target=/home/vscode/.config/infracost,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/gcloud,target=/home/vscode/.config/gcloud,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.config/starship.toml,target=/home/vscode/.config/starship.toml,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.kube,target=/home/vscode/.kube,type=bind,consistency=cached",
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.gitconfig,target=/home/vscode/.gitconfig,type=bind,consistency=cached",
+  ]
+}

.gitignore

@@ -13,8 +13,8 @@ crash.*.log
 # password, private keys, and other secrets. These should not be part of version 
 # control as they are data points which are potentially sensitive and subject 
 # to change depending on the environment.
-*.tfvars
-*.tfvars.json
+# *.tfvars
+# *.tfvars.json
 
 # Ignore override files as they are usually used to override resources locally and so
 # are not checked in

.gitmodules

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.terraform.lock.hcl

@@ -0,0 +1,27 @@
+# Contributing
+
+Thanks for considering contributing to Kubeflow Terraform Modules. We are open to contributions but please check via GitHub issues that we don't already provide the functionality you are requesting and that we are open to it being contributed.
+
+## Creating a development environment
+
+We recommend an Ubuntu environment running docker with 2 cpus and 16G of memory.
+
+This can be achieved using VSCode and the `.devcontainer` directory in this repo. A cloud VM gives the best performance.
+
+* [devcontainer docs](https://containers.dev/)
+* See the `.devcontainer` directory for details on dev dependencies, the main ones are:
+  * k3d
+  * helm CLI
+  * terraform CLI
+
+## Install from source
+
+While developing your change, install the K3s example into a local K3d cluster. Follow [the example](./examples/k3s/README.md) to do this.
+
+## Make a change
+
+You can change terraform files in the project then `terraform apply` to see them in your dev environment.
+
+## Ensure changes work in non K3s environments
+
+This can be validated by following examples other K8s providers such as EKS.