Skip to main content

User Support

Liquid Metal has a small but enthusiastic team, and a steadily growing community.

With that in mind, please bear with us as we try to solve your issues 😅.

Before participating in the Liquid Metal community, please have a read of our Code of Conduct which applies to users as well as builders of the project.

info

If you are contributing to the project and need help with your work, head to the contributing page.

Slack​

If your issue is a fairly straightforward "where is the doc for X?" or "does this config excerpt look right?" thing, then come post it in our slack channel.

Note that our core maintainers are in UTC so may not get back to you immediately if you post out of working hours.

If you do not get a response, open a ticket. Likewise, if your question turns out to have a more elaborate answer than you thought, you will be asked to open a discussion on the relevant repo so that someone in the community can be allocated and the process and answer tracked.

tip

Creating tickets for difficult questions helps us build a great knowledge base for current and future community members 💯.

Github​

We track all help tickets as discussions in Github.

tip

Before you open a new discussion, search existing discussions. Someone may have already asked the same thing and maybe even discovered the answer 🤞.

The Liquid Metal project has many repositories, so it may be tricky to figure out exactly where you should search for or open a ticket. Chances are it will be in one of two main repos, here are some general guidelines:

  • If something is going wrong in your CAPI management cluster, you'll want to open a ticket in capmvm.
  • If something is broken on your bare-metal device, it's probably flintlock.

These rules wont be perfect all the time, but in that case someone on the team will move the ticket to the correct place.

If you really don't know where the issue could possibly be coming from, just make your best guess, or open a ticket at the site repo. We'll move it for you later 🙂.

How to open a help ticket​

info

Help tickets are for those who are stuck trying to accomplish something. If you have found a bug, head to the contributing page 🐛.

Once you have found a repo which you hope is the correct one, go to the Discussions tab.

  1. Search existing discussions. If something similar already exists, please contribute to the conversation there.

  2. If you don't find anything, select Q&A, and click on New discussion.

  3. Start the title with "How to ...", eg "How to add SSH keys to my k8s cluster microvms?"

  4. Explain what you are trying to accomplish, what you have tried, and the behaviour you are seeing.

  5. Please include the exact the commands you're using, and all the steps you took to setup your environment. Please ensure everything is formatted nicely with code blocks.

  6. When providing verbose logs, please use either a Gist or HTML detail tags.

Once you have opened your ticket, drop a link to it in the slack channel to get more people involved.

Make sure any answers are captured in the discussion so it can help the next person 🎉.

It may turn out that it was a bug after all! In which case a new issue will be created, and the rest of the investigation will be tracked there.