Skip to content

Commit

Permalink
Refined readme (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyakooo0 authored Oct 5, 2021
1 parent cd1d726 commit 372f5dd
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<a href="https://github.com/typeable/octopod/actions?query=workflow%3ADocumentation+branch%3Amaster"><img src="https://github.com/typeable/octopod/workflows/Documentation/badge.svg?branch=master" alt="Documentation"></a>
</p>

_Octopod_ is a fully open-source self-service portal which empowers your team to leverage the full power of Kubernetes without the need for technical expertise.
_Octopod_ is a fully open-source self-service portal which empowers your team to leverage the full power of Helm without the need for technical expertise.

Octopod is a way for you to provide a simple interface for managing instances of a service in your Kubernetes cluster. Anything you can describe in a Helm Chart, any member of team can deploy. No matter how complex the deployment process is.
Octopod is a way for you to provide a self-service portal for managing instances of a service in your cluster. Anything you can describe in a Helm Chart, any member of team can deploy. No matter how complex the deployment process is.

The recipe is simple: you provide a url to your Helm repo, Octopod then automatically extracts the possible configuration that the Chart can have, and automatically manages the lifecycle of the services. What users see is just a simple web interface:

Expand All @@ -27,6 +27,15 @@ You can have the installation from the demo above running on your local machine

You can dive deeper into the installation process in our [deployment guide](docs/en/Octopod_deployment_guide.md).

<details>
<summary>You can remove everything the command above installs by running the following command:</summary>

```bash
kind delete cluster --name octopod
```

</details>

## Motivation

We created _Octopod_ because we believe that everything we release should be rigorously tested, however, such desires greatly [complicate the development workflow](docs/en/PM_case_study.md) leading to longer release cycles.
Expand Down Expand Up @@ -63,6 +72,17 @@ After you have Octopod up and running the only thing you need is a Helm Chart th

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

### Does _Octopod_ work with "vanilla" Kubernetes projects that don't use Helm?

If you do not have Helm Charts for your projects, you will not be able to leverage the simple Octopod installation procedure we have developed.

To use _Octopod_ with your project will need to either:

- Write Helm Charts for your project
- Write a set of [_control scripts_][cs] that deploy "vanilla" Kubernetes services

You can always contact us if you need help. A good first place to ask questions is [Octopod Discussions](https://github.com/typeable/octopod/discussions).

### 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.
Expand Down
Binary file modified img/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions octopod_local_install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ set -e
message () {
echo "==> $1"
}

echo
echo " 🔖 If you encounter any issues during the installation please open an issue:"
echo " https://github.com/typeable/octopod/issues/new"
echo

for cmd in kind kubectl helm; do
if ! command -v $cmd &> /dev/null; then
message "$cmd is not installed. Please, install it!"
Expand Down

0 comments on commit 372f5dd

Please sign in to comment.