diff --git a/.gitignore b/.gitignore index a5a330b..376b19b 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ deploy/compose/state/webroot/workflow/* !deploy/compose/state/webroot/workflow/.keep deploy/compose/state/webroot/*.gz workflow_id.txt +compose.tar.gz diff --git a/QuickStart.md b/QuickStart.md deleted file mode 100644 index 9e49dfa..0000000 --- a/QuickStart.md +++ /dev/null @@ -1,14 +0,0 @@ -# Quick-Starts - -The following quick-start guides will walk you through standing up the Tinkerbell stack. -There are a few options for this. -Pick the one that works best for you. - -## Options - -- [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) diff --git a/README.md b/README.md new file mode 100644 index 0000000..601c0cd --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# Quick-Starts + +The following quick-start guides will walk you through standing up the Tinkerbell stack. +There are a few options for this. +Pick the one that works best for you. + +## Options + +- [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. + +1. [Create Hardware Data](https://docs.tinkerbell.org/setup/local-vagrant/#creating-the-workers-hardware-data) +2. [Create a Template](https://docs.tinkerbell.org/setup/local-vagrant/#creating-a-template) +3. [Create a Workflow](https://docs.tinkerbell.org/setup/local-vagrant/#creating-the-workflow) + +### In the Sandbox + +1. Create your own templates + + ```bash + docker exec -i compose_tink-cli_1 tink template create < ./custom-template.yaml + ``` + +2. Upload any container images you want to use in the templates to the internal registry + + ```bash + docker run -it --rm quay.io/containers/skopeo copy --all --dest-tls-verify=false --dest-creds="admin":"Admin1234" docker://hello-world docker://192.168.50.4/hello-world + ``` + +3. Create a workflow + + ```bash + docker exec -i compose_tink-cli_1 tink workflow create -t