Skip to content

Commit

Permalink
Update README.md to point to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasT committed Apr 27, 2018
1 parent 79729ed commit 86857fa
Showing 1 changed file with 16 additions and 58 deletions.
74 changes: 16 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# metal-k8s
An opinionated Kubernetes distribution with a focus on long-term on-prem deployments

# Hardware prerequisite
## Quickstart
For the really impatient, there's a [quickstart] available.

## Test config
If you want to test metal-k8s you just need one simple VM running ubuntu
16.04
[quickstart]: https://metal-k8s.readthedocs.io/en/latest/usage/quickstart.html

## Production Config
## Documentation
The project documentation is available at https://metal-k8s.readthedocs.io.
Sources can be found in the `docs` folder of this repository. Pull-requests
welcome!

## Hardware Requirements

### Test config
If you want to test metal-k8s you just need one simple VM running CentOS 7.4.

### Production Config
For production-ready environment, you need:

- 5 servers
Expand All @@ -17,56 +26,5 @@ For production-ready environment, you need:
- a "/var"/ partition of at least 100G
- 1 extra-drive of 500Go per-server


## Software prerequisite for host running metal-k8s

### Install
You need ansible. You can create a virtualenv
```
cd metal-k8s
virtualenv venv
source ./venv/bin/activate
pip install ansible
```

## Inventory file
Create an inventory file somewhere on the file system. You can make use of
`inventories` directory, but it's ignore from git by default, so make sure to
not store precious data under this directory

For example in `inventories/example.cfg'

```
node1 ansible_ssh_host=95.54.0.12
[kube-master]
node1
[etcd]
node1
[kube-node]
node1
[k8s-cluster:children]
kube-node
kube-master
```

## Roll !
If you pocede all the step above, you can launch the `metal-k8s.yml`:

```
ansible-playbook -i inventories/example.cfg metal-k8s.yml
```

## Usage
You also need `kubectl` and `helm` binary to play with your cluster from your
local computer.

Please refer to the official documentation to install those tools:

- https://kubernetes.io/docs/tasks/tools/install-kubectl/
- https://docs.helm.sh/using_helm/#installing-helm
## Software Requirements
To get started, all you need is `python` and `make` on a Unix-like system.

0 comments on commit 86857fa

Please sign in to comment.