typeable/octopod
1
0
Fork 0
mirror of https://github.com/typeable/octopod.git synced 2024-11-22 16:56:29 +03:00
Code Issues Projects Releases Wiki Activity
fe69f08eec
octopod/README.md
iko fe69f08eec Added Kubernetes Dashboard button to Web UI (#14) 
* Added logs url support to the frontend

* Added k8s dashboard URL to charts and deployment guide

* Added troubleshooting to FAQ

* Tweaked docs.

* Resolved comments

* Renamed button to Details
2021-01-25 18:40:35 +03:00

5.1 KiB
Raw Blame History

🐙 Octopod Octopod Docker Image octo CLI Documentation

Octopod is a fully open-source self-hosted solution for managing multiple deployments in a Kubernetes cluster with a user-friendly web interface. Managing deployments does not require any technical expertise.

We created Octopod because we believe that everything we release should be rigorously tested, however, such desires greatly complicate the development workflow leading to longer release cycles. We use Octopod to mitigate the downsides of rigorously testing each feature by deploying every single change we make to a separate staging environment allowing QA to investigate each feature independently and in parallel.

🖥 Demo

📑 Documentation

🔭 High-level notes

🛠️ Technical documentation

ℹ️ FAQ

How long does it take to set up Octopod?

The longest part of setting up Octopod for your project will probably be writing Control Scripts. In total you should be able to get things running in about a day.

Will Octopod work with my project if it uses X?

Yes. Octopod is project-agnostic. If you can run your project in a Docker container, then you can use Octopod with that project.

What do I need to know to set up Octopod?

You need to understand the basics of Kubernetes and be familiar with whatever hosting provider you will be using. There is no need to know any special language – you can write Control Scripts in whatever language you like.

Does Octopod work with my CI?

Yes. If you can run arbitrary executables in your CI, then you will be able to integrate it with Octopod. Integration basically consists of calling our octo CLI tool to perform desired actions. You can find more detail in the CI integration doc.

How come I can't see the deployment logs in Octopod web app?

It's been excluded from the GUI because we don't have a good security story to accompany this feature yet. Some secrets and credentials may leak to the project team using Octopod and, potentially, not everyone should have access to this data.

Octopod says "Failure" next to my deployment. Why is it not working?

There are several places where things can go wrong:

  1. Your DevOps engineer could have made mistakes in one of the Control Scripts leading to an improper deployment process.

    To fix this the DevOps engineer can use the octo CLI to see detailed logs collected during the deployment process and diagnose the issue.

  2. You could have one of the steps of your deployment failing (for example, a failing database migration).

    If you have supplied a Kubernetes Dashboard URL to Octopod during deployment, then you will have a "Details" button in the Web UI. You can click that button to get a filtered view of the Kubernetes Dashboard where you can see what could have gone wrong and diagnose the issue.

Why Haskell and Rust?

We believe that there is a lot to be gained in programming in general by being able to statically ensure invariants in your code. One of the most practical ways of ensuring invariants is a good static type system. Haskell and Rust are both languages that have very strong type systems. This allows us to move fast without breaking things in the process.

❓ Still have questions?

If you still have questions, be sure to ask them in our Octopod Discussions.