From 459dc885bce5637485bf9089f9deb477cce9c57b Mon Sep 17 00:00:00 2001 From: Benjamin Huo Date: Fri, 29 Jul 2022 20:10:48 +0800 Subject: [PATCH] Add install options Signed-off-by: Benjamin Huo --- README.md | 14 ++++---- .../en/docs/getting-started/installation.md | 36 +++++++++++++++---- 2 files changed, 36 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 59c5608e..331527a2 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ Contributions of any kind are welcome! 2. Run the following commands to clone your fork and enter into it. Make sure you replace `` with your GitHub ID. ``` - git clone https://github.com//website.git - cd website + git clone https://github.com//openfunction.dev.git + cd openfunction.dev ``` -### Build and preview the website +### Build and preview the openfunction.dev #### Pre-requisites @@ -27,12 +27,12 @@ Contributions of any kind are welcome! 1. Ensure pre-requisites are installed 1. Clone repository -1. Change to website directory: `cd website` +1. Change to openfunction.dev directory: `cd openfunction.dev` 1. Add Docsy submodule: `git submodule add https://github.com/google/docsy.git themes/docsy` 1. Update submodules: `git submodule update --init --recursive` 1. Install npm packages: `npm install` -### Running the website locally +### Running the openfunction.dev locally After you setup the environment, run the following command: @@ -40,11 +40,11 @@ After you setup the environment, run the following command: hugo server -D ``` -Now you can preview the website in your browser at `http://localhost:1313/`. +Now you can preview the openfunction.dev in your browser at `http://localhost:1313/`. ### Open a pull request -Open a [pull request (PR)](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request#creating-a-new-pull-request) to contribute to our website. Use DCO sign-off when you submit a PR by running the command below (add `-s`): +Open a [pull request (PR)](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request#creating-a-new-pull-request) to contribute to our openfunction.dev. Use DCO sign-off when you submit a PR by running the command below (add `-s`): ```bash git commit -s -m "xxx" diff --git a/content/en/docs/getting-started/installation.md b/content/en/docs/getting-started/installation.md index 87533599..0acffa2b 100644 --- a/content/en/docs/getting-started/installation.md +++ b/content/en/docs/getting-started/installation.md @@ -41,24 +41,46 @@ This option is the **recommended** installation method. - Helm version: `>=v3.6.3` #### install the chart -1. Run the following command to add the OpenFunction chart repository. + +1. Run the following command to add the OpenFunction chart repository first: ```shell helm repo add openfunction https://openfunction.github.io/charts/ helm repo update ``` -2. Run the following command to install the OpenFunction chart. - ```shell - kubectl create namespace openfunction - helm install openfunction openfunction/openfunction -n openfunction - ``` +2. Then you have several options to setup OpenFunction, you can choose to: + + - Install all components: + ```shell + kubectl create namespace openfunction + helm install openfunction openfunction/openfunction -n openfunction + ``` + + - Install Serving only (without build): + ```shell + kubectl create namespace openfunction + helm install openfunction --set ShipwrightBuild.enabled=false --set TektonPipelines.enabled=false openfunction/openfunction -n openfunction + ``` + + - Install Knative sync runtime only: + ```shell + kubectl create namespace openfunction + helm install openfunction --set Keda.enabled=false openfunction/openfunction -n openfunction + ``` + + - Install OpenFunction async runtime only: + ```shell + kubectl create namespace openfunction + helm install openfunction --set IngressNginx.enabled=false --set KnativeServing.enabled=false openfunction/openfunction -n openfunction + ``` + {{% alert title="Note" color="success" %}} For more information about how to install OpenFunction with Helm, see [Install OpenFunction with Helm](https://github.com/OpenFunction/charts/tree/release-0.6#install-the-chart). {{% /alert %}} -3. Run the following command to verify OpenFunction is ready. +3. Run the following command to verify OpenFunction is up and running: ```shell kubectl get pods -namespace openfunction ```