diff --git a/docs/README.md b/docs/README.md index 50c84b4..8c77a68 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,10 @@ The goal of this project is to setup a minimal kubernetes environment for deploy Pocket is based on [(Linux) containers](https://docker.io), [Kubernetes](https://kubernetes.io) and [KIND](https://kind.sigs.k8s.io). +## Security + +Pocket exposes most of its services on the host to the outside network. It should only be run in a protected environment where it is safe to expose these services! + ## Installation ### Requirements @@ -20,13 +24,13 @@ Utilities: - `jq` - `sed` -You must also have a functional [`docker` installation](https://docs.docker.com/engine/install/) that can download container images from the internet. +You must also have a functional [`docker` server installation](https://docs.docker.com/engine/install/#server) that can download container images from the internet. -On CentOS/SL/Alma9, as root: -``` - $ [yum|dnf] -y install docker-ce - $ systemctl enable docker - $ systemctl start docker +On Alma/CentOS/SL: +```bash +sudo [yum|dnf] -y install docker-ce +sudo systemctl enable docker +sudo systemctl start docker ``` ## Setup @@ -38,29 +42,50 @@ git clone https://github.com/DUNE-DAQ/pocket.git cd pocket make help ``` -## create pocketdune cluster + +Select the workflow you desire from the output of `make help`. Odds are it is `make recreate-pocketdune-cluster`. + +### local storage + +This setup will use `./local` to store your persistant disks. You can replace this directory with a symbolic link to another location before you run the `make` commands - but not after. + +## Test your system + +Check that your system has the required utilities installed and working: ```bash -make create-pocketdune-cluster +make test-shell-utils ``` -## setup your path +## Create pocketdune cluster + +Now you can create a pocketdune cluster on your system: +```bash +make create-pocketdune-cluster ``` + +This will also provide some output to help you quickly deploy content into the new cluster. + +## Setup your PATH + +As a part of the create process a handful of utilities will be downloaded. You'll need these in your `$PATH` to use them. + +```bash eval $(make env) ``` -Select the workflow you desire from the output of `make help`. Odds are it is `make recreate-pocketdune-cluster`. - -The utilities this workflow installs can be added to your `$PATH` via `eval $(make env)`. +## Cleanup pocketdune cluster -### Security +Once you are done with the cluster, you can remove it with: -Pocket exposes most of its services on the host to the outside network. It should only be run in a protected environment where it is safe to expose these services! +```bash +make remove-pocketdune-cluster +``` ## Deployment -Once you have created the kind cluster via this project, you should be able to select your deployment target from `daq-kube`. See that repo for instructions +Once you have created the kind cluster via this project, you should be able to select your deployment target from `daq-kube`. See that [repo](https://github.com/DUNE-DAQ/daq-kube) for instructions. If you recieve: @@ -69,7 +94,3 @@ If you recieve: ``` You should first `cd daq-kube`. - -### local storage - -This setup will use `./local` to store your persistant disks. You can replace this directory with a symbolic link to another location.