From 446e36b977a1253682c7b147453a157ad695475b Mon Sep 17 00:00:00 2001 From: afkham Date: Mon, 1 Jul 2019 12:47:24 +0530 Subject: [PATCH] More improvements to README --- docs/community.md | 2 +- docs/installation-options.md | 29 +++++++++++++++++++++++++++++ docs/setup/existing-cluster.md | 2 +- docs/writing-a-cell.md | 2 +- 4 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 docs/installation-options.md diff --git a/docs/community.md b/docs/community.md index 30404ce4..3841424e 100644 --- a/docs/community.md +++ b/docs/community.md @@ -1 +1 @@ -TODO \ No newline at end of file +### Cellery community \ No newline at end of file diff --git a/docs/installation-options.md b/docs/installation-options.md new file mode 100644 index 00000000..cabba2fd --- /dev/null +++ b/docs/installation-options.md @@ -0,0 +1,29 @@ +## Cellery runtime installation options + +### Basic vs. complete installations +When it comes to installing Cellery, you could choose between the basic or complete installation options. +When you run the `cellery setup` command, you can choose to either install the basic or complete version. +The basic installation would require less resources in comparison to the complete installation. +The following table offers a comparison between what you would get. + +| Packages | Components | Supported Functionality | +|----------|------------|-------------------------| +| Basic | | | +| Complete | | | + +### Local, existing Kubernetes cluster and GCP based installations + +You could opt to install Cellery either in local mode, on to an existing Kubernetes cluster or on Google Cloud. +Note that you could combine either the basic or complete installations along with these options. + +When you run `cellery setup` in interactive mode, and select `Create`, you can select one of the following options: + +* `Local` -> to install locally via a pre-built VM +* `Existing cluster` -> to install into an existing K8s cluster (e.g. Docker for Desktop) +* `GCP` -> to install on Google Cloud + +The following links explain in detail the setup options for different environments. + +* [1. Local setup](docs/setup/local-setup.md) +* [2. Existing Cluster](docs/setup/existing-cluster.md) +* [3. GCP setup](docs/setup/gcp-setup.md) \ No newline at end of file diff --git a/docs/setup/existing-cluster.md b/docs/setup/existing-cluster.md index d88291d6..fcbef2da 100644 --- a/docs/setup/existing-cluster.md +++ b/docs/setup/existing-cluster.md @@ -1,4 +1,4 @@ -Existing kubernetes setup +Existing Kubernetes cluster --- Cellery runtime can be installed onto an existing k8s clusters. Cellery runtime requires MySQL server to store the control plane state, and MySQL server can be started within kubernetes with persistent volume mounted or not. diff --git a/docs/writing-a-cell.md b/docs/writing-a-cell.md index 743c50de..ee9e3e6b 100644 --- a/docs/writing-a-cell.md +++ b/docs/writing-a-cell.md @@ -1,4 +1,4 @@ -### Developing & running your first cell +## Developing & running your first cell In this section let's focus on initialize, build, run and push the same hello world cell explained above. Follow the instructions listed below to create your first cell.