Skip to content

Commit 3359f00

Browse files
authored
Add install options (#177) (#178)
Signed-off-by: Benjamin Huo <benjamin@kubesphere.io>
1 parent 5fb124d commit 3359f00

File tree

2 files changed

+36
-14
lines changed

2 files changed

+36
-14
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Contributions of any kind are welcome!
1313
2. Run the following commands to clone your fork and enter into it. Make sure you replace `<Your GitHub ID>` with your GitHub ID.
1414

1515
```
16-
git clone https://github.com/<Your GitHub ID>/website.git
17-
cd website
16+
git clone https://github.com/<Your GitHub ID>/openfunction.dev.git
17+
cd openfunction.dev
1818
```
19-
### Build and preview the website
19+
### Build and preview the openfunction.dev
2020

2121
#### Pre-requisites
2222

@@ -27,24 +27,24 @@ Contributions of any kind are welcome!
2727

2828
1. Ensure pre-requisites are installed
2929
1. Clone repository
30-
1. Change to website directory: `cd website`
30+
1. Change to openfunction.dev directory: `cd openfunction.dev`
3131
1. Add Docsy submodule: `git submodule add https://github.com/google/docsy.git themes/docsy`
3232
1. Update submodules: `git submodule update --init --recursive`
3333
1. Install npm packages: `npm install`
3434

35-
### Running the website locally
35+
### Running the openfunction.dev locally
3636

3737
After you setup the environment, run the following command:
3838

3939
```
4040
hugo server -D
4141
```
4242

43-
Now you can preview the website in your browser at `http://localhost:1313/`.
43+
Now you can preview the openfunction.dev in your browser at `http://localhost:1313/`.
4444

4545
### Open a pull request
4646

47-
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`):
47+
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`):
4848

4949
```bash
5050
git commit -s -m "xxx"

content/en/docs/getting-started/installation.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,24 +41,46 @@ This option is the **recommended** installation method.
4141
- Helm version: `>=v3.6.3`
4242

4343
#### install the chart
44-
1. Run the following command to add the OpenFunction chart repository.
44+
45+
1. Run the following command to add the OpenFunction chart repository first:
4546
```shell
4647
helm repo add openfunction https://openfunction.github.io/charts/
4748
helm repo update
4849
```
4950

50-
2. Run the following command to install the OpenFunction chart.
51-
```shell
52-
kubectl create namespace openfunction
53-
helm install openfunction openfunction/openfunction -n openfunction
54-
```
51+
2. Then you have several options to setup OpenFunction, you can choose to:
52+
53+
- Install all components:
54+
```shell
55+
kubectl create namespace openfunction
56+
helm install openfunction openfunction/openfunction -n openfunction
57+
```
58+
59+
- Install Serving only (without build):
60+
```shell
61+
kubectl create namespace openfunction
62+
helm install openfunction --set ShipwrightBuild.enabled=false --set TektonPipelines.enabled=false openfunction/openfunction -n openfunction
63+
```
64+
65+
- Install Knative sync runtime only:
66+
```shell
67+
kubectl create namespace openfunction
68+
helm install openfunction --set Keda.enabled=false openfunction/openfunction -n openfunction
69+
```
70+
71+
- Install OpenFunction async runtime only:
72+
```shell
73+
kubectl create namespace openfunction
74+
helm install openfunction --set IngressNginx.enabled=false --set KnativeServing.enabled=false openfunction/openfunction -n openfunction
75+
```
76+
5577
{{% alert title="Note" color="success" %}}
5678

5779
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).
5880

5981
{{% /alert %}}
6082

61-
3. Run the following command to verify OpenFunction is ready.
83+
3. Run the following command to verify OpenFunction is up and running:
6284
```shell
6385
kubectl get pods -namespace openfunction
6486
```

0 commit comments

Comments
 (0)