Skip to content

Commit ec83c6c

Browse files
benjaminhuobenjaminhuo
authored
Remove ofn cli install/uninstall docs (#294)
Signed-off-by: Benjamin Huo <benjamin@kubesphere.io> Signed-off-by: Benjamin Huo <benjamin@kubesphere.io>
1 parent fb2c25e commit ec83c6c

File tree

2 files changed

+0
-363
lines changed

2 files changed

+0
-363
lines changed

‎content/en/docs/reference/cli.md‎

Lines changed: 0 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ The following table describes the main commands supported by ofn.
1717
| Command | Description |
1818
| ------------- | ------------------------------------------------------------ |
1919
| `init` | Provides management for the framework of OpenFunction. |
20-
| `install` | Installs OpenFunction and its dependencies. |
21-
| `uninstall` | Uninstalls OpenFunction and its dependencies. |
2220
| `create` | Creates a function from a file or stdin. |
2321
| `apply` | Applies a function from a file or stdin. |
2422
| `demo` | Creates a [kind cluster](https://kind.sigs.k8s.io/) to install OpenFunction and run its demo. |
@@ -27,96 +25,6 @@ The following table describes the main commands supported by ofn.
2725
| `get serving` | Prints important information about the Serving. |
2826
| `delete` | Deletes the specified function. |
2927

30-
## Use ofn to Install and Uninstall OpenFunction
31-
32-
1. Run the following command to download ofn.
33-
34-
```shell
35-
wget -c https://github.com/OpenFunction/cli/releases/latest/download/ofn_linux_amd64.tar.gz -O - | tar -xz
36-
```
37-
38-
2. Run un the following commands to make `ofn` executable and move it to `/usr/local/bin/`.
39-
40-
```shell
41-
chmod +x ofn && mv ofn /usr/local/bin/
42-
```
43-
44-
{{% alert title="Note" color="success" %}}
45-
46-
If you download ofn from [the release page](https://github.com/OpenFunction/cli/releases), make sure you put ofn in the correct directory.
47-
48-
{{% /alert %}}
49-
50-
3. Run the following command to install OpenFunction.
51-
52-
```shell
53-
ofn install --all
54-
```
55-
56-
3. Run the following command to uninstall OpenFunction and its dependencies.
57-
58-
```shell
59-
ofn uninstall --all
60-
```
61-
62-
{{% alert title="Note" color="success" %}}
63-
64-
You can also remove the `--all` parameter to just uninstall OpenFunction.
65-
66-
{{% /alert %}}
67-
68-
## `ofn install` Parameters
69-
70-
The following table describes parameters available for the `ofn install` command.
71-
72-
| Parameter | Description |
73-
| --------------------------------- | ------------------------------------------------------------ |
74-
| --all | For installing all dependencies. |
75-
| --async | For installing OpenFunction Async runtime (Dapr & KEDA). |
76-
| --cert-manager | For installing Cert Manager. |
77-
| --dapr | For installing Dapr. |
78-
| --dry-run | For previewing the components and their versions to be installed. |
79-
| --ingress | For installing Ingress Nginx. |
80-
| --keda | For installing KEDA. |
81-
| --knative | For installing Knative Serving (with Kourier as the default gateway). |
82-
| --region-cn | For users who have limited access to gcr.io or github.com. If you add this parameter in the `ofn install` command, you have to add it again in the `ofn uninstall` command. |
83-
| --shipwright | For installing Shipwright. |
84-
| --sync | For installing OpenFunction Sync runtime (to be supported). |
85-
| --upgrade | For upgrading components to target versions during installation. |
86-
| --yes | For automatically passing yes to prompts. (`-y` for short) |
87-
| --verbose | For displaying detailed information. |
88-
| --version &lt; version number&gt; | For specifying any stable version or the latest version of OpenFunction for installation. (default "v0.4.0") If not specified, the latest stable version will be installed. |
89-
| --timeout &lt; duration &gt; | For specifying the timeout duration, which defaults to 5 minutes. |
90-
91-
## `ofn uninstall` Parameters
92-
93-
The following table describes parameters available for the `ofn uninstall` command.
94-
95-
| Parameter | Description |
96-
| --------------------------------- | ------------------------------------------------------------ |
97-
| --all | For uninstalling all dependencies. |
98-
| --async | For uninstalling OpenFunction Async runtime (Dapr & KEDA). |
99-
| --cert-manager | For uninstalling Cert Manager. |
100-
| --dapr | For uninstalling Dapr. |
101-
| --dry-run | For previewing the components and their versions to be uninstalled. |
102-
| --ingress | For uninstalling Ingress Nginx. |
103-
| --keda | For uninstalling KEDA. |
104-
| --knative | For uninstalling Knative Serving (with Kourier as the default gateway). |
105-
| --region-cn | For users who have limited access to gcr.io or github.com. If you add this parameter in the `ofn install` command, you have to add it again in the `ofn uninstall` command. |
106-
| --shipwright | For uninstalling Shipwright. |
107-
| --sync | For uninstalling OpenFunction Sync runtime (to be supported). |
108-
| --verbose | For displaying detailed information. |
109-
| --yes | For automatically passing yes to prompts. (`-y` for short) |
110-
| --version &lt; version number&gt; | For specifying any stable version or the latest version of OpenFunction to be uninstalled. If not specified, the currently installed version will be uninstalled. |
111-
| --wait | For awaiting the results of the uninstallation until namespaces are cleaned up. |
112-
| --timeout &lt; duration &gt; | For specifying the timeout duration, which defaults to 5 minutes. |
113-
114-
### Inventory
115-
116-
During installation, the OpenFunction CLI keeps the installed component details in `$home/.ofn/<cluster name>-inventory.yaml`. Therefore, during uninstallation, the OpenFunction CLI removes the installed components based on the contents of `$home/.ofn/<cluster name>-inventory.yaml`.
117-
118-
In addition, the OpenFunction CLI supports obtaining component versions and paths to the component YAML files from environment variables.
119-
12028
## `ofn demo` Parameters
12129

12230
The following table describes parameters available for the `ofn demo` command.

0 commit comments

Comments
 (0)