Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Batteries Included Experience #54

Closed
5 of 8 tasks
mrmrcoleman opened this issue May 19, 2020 · 4 comments
Closed
5 of 8 tasks

Batteries Included Experience #54

mrmrcoleman opened this issue May 19, 2020 · 4 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects

Comments

@mrmrcoleman
Copy link
Contributor

mrmrcoleman commented May 19, 2020

We should aim to reduce a user's "time to dopamine" by creating an unboxing experience that allows users to get Tinkerbell up and running and doing something useful or interesting, quickly. This is split into three sections:

Setup Experience

The docs should cover how to set up the provisioner in the following situations:

  • 1. On Packet, using Terraform
  • 2. Local with VMs (Vagrant/VirtualBox etc) (Ubuntu 18.04 provisioner)

Examples

  • Example 1: Install Ubuntu 18.04 on worker and add ssh key

Documentation

The documentation should introduce terminology inline so that users don't need to constantly click away breaking their flow.

Let's please have someone from outside of the core team (like Devrel) try out the docs before we push them out to make sure they are understandable to people without intimate knowledge of Tinkerbell.

As the unboxing experience can be degraded by out of date code examples, let's also set up CI to test each of the workflows, including a nightly build in case of Packet API changes.

To come back to:

  • 2. Local Ubuntu 18.04 & 20.04 , CentOS 7 & 8 (pre-amble including assumptions i.e. two machines in a flat layer 2 environment)
  • RPI4
  • Example 2: Spin up a k8s cluster on the worker(s) <-- We can reference Adam Otto's work for this
  • Example 3: Show how a user can bring their own ISO
  • Example 4: Flatcar Linux ← content/examples: add Flatcar Container Linux provisioning page #28
@mrmrcoleman mrmrcoleman created this issue from a note in Roadmap (In progress) May 19, 2020
@alexellis
Copy link

alexellis commented May 19, 2020

For 3 specifically, it would be good to have an example using a cloud image, like the ones Ubuntu create. https://cloud-images.ubuntu.com

@alexellis
Copy link

alexellis commented May 19, 2020

For 1 see tinkerbell/tink#91

@alexellis
Copy link

Got a bit impatient wanting to have a working Ubuntu install for an event this week. This is a collaboration with @wangxin311 https://github.com/alexellis/tink-workflow

It works at the moment and can get from nothing to a working 18.04 machine with ssh enabled from the provisioner and a username that can be used on the console via SSH SOS on Packet.

@mrmrcoleman mrmrcoleman moved this from In progress to Done in Roadmap Nov 5, 2020
@tstromberg tstromberg added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 27, 2021
@tstromberg
Copy link
Contributor

Closing, as the item is both sort of done, and sort of not. We'll revisit this sort of work with more specifics at some point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
No open projects
Roadmap
  
Done
Development

No branches or pull requests

3 participants