Skip to content

Commit

Permalink
Add information from deprecated kubernete.sh site
Browse files Browse the repository at this point in the history
  • Loading branch information
brotandgames committed Apr 16, 2022
1 parent c2a0fd1 commit 10196e1
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 9 deletions.
58 changes: 49 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Deploy "throw-away" Kubernetes Cluster(s) using a small Bash CLI.

[Home](https://kubernete.sh) |
[About](https://kubernete.sh/about/) |
[Installation](https://kubernete.sh/install/) |
[Usage](https://kubernete.sh/usage/)
![kubernete.sh Example](./assets/kubernete.sh.svg "kubernete.sh")

![kubernete.sh Example](https://kubernete.sh/assets/kubernete.sh.svg "kubernete.sh")
`kubernete.sh` deploys a Kubernetes Cluster with 1 to _N_ nodes with Kubernetes Dashboard included.
It combines _well-known_ libraries [under the hood](#under-the-hood) to make entry to Kubernetes easier.

Use it for your development & ci/cd ("throw-away") environments.
Out of the box it's not for production use.

## tl;dr

````
```sh
$ kubernete.sh
kubernete.sh
https://github.com/brotandgames/kubernete.sh
Expand All @@ -27,9 +27,9 @@ Commands:
version Print version
* Help

````
```

````
```sh
$ kubernete.sh deploy
== kubernete.sh 2019-05-03T18:46:14Z ERROR: No nodes argument found.
Command:
Expand All @@ -41,7 +41,47 @@ Usage:
Examples:
kubernete.sh deploy [email protected]
kubernete.sh deploy [email protected],[email protected] ~/.ssh/id_rsa
````
```

## Requirements

`kubernete.sh` has the following requirements:

- [terraform](https://www.terraform.io/downloads.html)
- [terraform-rke-provider](https://github.com/yamamoto-febc/terraform-provider-rke)
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-minikube/#install-kubectl)

## Installation

```sh
# Download current version of kubernete.sh Bash CLI
curl https://raw.githubusercontent.com/brotandgames/kubernete.sh/v0.1.2/kubernete.sh \
-o /usr/local/bin/kubernete.sh

# Make it executable
chmod +x /usr/local/bin/kubernete.sh
```

## Quick start

```sh
# Create project folder
mkdir my-k8s-cluster && cd my-k8s-cluster

# Deploy Kubernetes Cluster with 2 nodes using SSH Private Key
kubernete.sh deploy [email protected],[email protected] ~/.ssh/id_rsa
```

## Under the Hood

Under the hood `kubernete.sh` uses awesome open source libraries:

- [terraform](https://github.com/hashicorp/terraform) and [rke](https://github.com/rancher/rke) (using the [terraform-rke-provider](https://github.com/yamamoto-febc/terraform-provider-rke)) to deploy a Kubernetes Cluster with the Kubernetes Dashboard as an addon.
- [kubectl](https://github.com/kubernetes/kubectl) to get the Kubernetes Dashboard user token and to proxy from localhost to the server.

## Open Source

We <3 Free Software. Sharing is caring.

## Maintainer

Expand Down
48 changes: 48 additions & 0 deletions assets/kubernete.sh.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 10196e1

Please sign in to comment.