Merge pull request #179 from jacobweinstock/update

Remove unsupported deployment options

.github/workflows/ci-non-go.sh

@@ -18,15 +18,7 @@ if ! shfmt -f . | xargs shfmt -s -l -d; then
 	failed=1
 fi
 
-if ! make lint; then
-	failed=1
-fi
-
-if ! terraform fmt -write -recursive deploy/infrastructure/terraform/; then
-	failed=1
-fi
-
-if ! rufo deploy/infrastructure/vagrant/Vagrantfile; then
+if ! rufo vagrant/Vagrantfile; then
 	failed=1
 fi
 

.gitignore

@@ -1,24 +1 @@
-# hidden files/dirs
-.*
-!deploy/infrastructure/vagrant/.env
-!deploy/infrastructure/terraform/.env
-!deploy/stack/compose/.env
-!.gitignore
-!.github/
-
-# Local .terraform directories
-.terraform*
-!.terraform.lock.hcl
-
-# .tfstate files
-*.tfstate
-*.tfstate.*
-
-compose.tar.gz
-compose.zip
-deploy/stack/compose/manifests/manifests.yaml
-deploy/stack/compose/state/*
-!deploy/stack/compose/state/.keep
-envrc
-out
-workflow_id.txt
+.vagrant

README.md

@@ -1,4 +1,9 @@
-# Quick-Starts
+# Playground
+
+The playground is an example deployment of the Tinkerbell stack for use in learning and testing. It is not a production reference architecture.
+Please use the [Helm chart](https://github.com/tinkerbell/charts) for production deployments.
+
+## Quick-Starts
 
 The following quick-start guides will walk you through standing up the Tinkerbell stack.
 There are a few options for this.
@@ -8,35 +13,28 @@ Pick the one that works best for you.
 
 - [Vagrant and VirtualBox](docs/quickstarts/VAGRANTVBOX.md)
 - [Vagrant and Libvirt](docs/quickstarts/VAGRANTLVIRT.md)
-- [Docker Compose](docs/quickstarts/COMPOSE.md)
-- [Terraform and Equinix Metal](docs/quickstarts/TERRAFORMEM.md)
 - [Kubernetes](docs/quickstarts/KUBERNETES.md)
-- [Multipass](docs/quickstarts/MULTIPASS.md)
 
 ## Next Steps
 
-Now that you have a Tinkerbell stack up and running, you can start provisioning machines.
-Tinkerbell.org has a [list of guides](https://docs.tinkerbell.org/deploying-operating-systems/the-deployment/) for provisioning machines.
-You can also create your own.
-The following docs will help you get started.
+By default the Vagrant quickstart guides automatically install Ubuntu on the VM (machine1). You can provide your own OS template. To do this:
 
-1. [Example Hardware object](https://github.com/tinkerbell/tink/tree/main/config/crd/examples/hardware.yaml)
-2. [Example Template object](https://github.com/tinkerbell/tink/tree/main/config/crd/examples/template.yaml)
-   - Template [documentation](https://docs.tinkerbell.org/templates/)
-3. [Example Workflow object](https://github.com/tinkerbell/tink/tree/main/config/crd/examples/workflow.yaml)
+1. Login to the stack VM
 
-### In the Sandbox
+   ```bash
+   vagrant ssh stack
+   ```
 
-1. Add your templates
+1. Add your template. An example Template object can be found [here](https://github.com/tinkerbell/tink/tree/main/config/crd/examples/template.yaml) and more Template documentation can be found [here](https://docs.tinkerbell.org/templates/).
 
    ```bash
-   kubectl apply -f my-custom-template.yaml
+   kubectl apply -f my-OS-template.yaml
    ```
 
-2. Create the workflow
+1. Create the workflow. An example Workflow object can be found [here](https://github.com/tinkerbell/tink/tree/main/config/crd/examples/workflow.yaml).
 
    ```bash
    kubectl apply -f my-custom-workflow.yaml
    ```
 
-3. Restart the machine to provision (if using the vagrant sandbox test machine this is done by running `vagrant destroy -f machine1 && vagrant up machine1`)
+1. Restart the machine to provision (if using the vagrant sandbox test machine this is done by running `vagrant destroy -f machine1 && vagrant up machine1`)