Skip to content

Add install options (#177) #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2022
Merged

Add install options (#177) #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<Your GitHub ID>` with your GitHub ID.

```
git clone https://github.com/<Your GitHub ID>/website.git
cd website
git clone https://github.com/<Your GitHub ID>/openfunction.dev.git
cd openfunction.dev
```
### Build and preview the website
### Build and preview the openfunction.dev

#### Pre-requisites

Expand All @@ -27,24 +27,24 @@ 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:

```
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"
Expand Down
36 changes: 29 additions & 7 deletions content/en/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down