knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add label install to guides, update Minikube (#1195) 

* Add label install to guides, update Minikube

* -l to --selector

* Update wording for install

* plug-ins to plugins (remove hyphen)
This commit is contained in:
Sam O'Dell 2019-04-18 12:59:26 -07:00 committed by Knative Prow Robot
parent bafe7456dd
commit 15488da77f
10 changed files with 203 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/install/Knative-custom-install.md
View File

@ -226,7 +226,7 @@ files from the Knative repositories:
_\*_ See
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md)
for details about installing the various supported observability plug-ins.
for details about installing the various supported observability plugins.
† These are the recommended standard install files suitable for most use cases.
@ -304,23 +304,27 @@ commands below.
completed until the upgrade process finishes.
1. To install Knative components or plugins, specify the filenames in the
`kubectl apply` command:
- To install an individual component or plgugin
`kubectl apply` command. To prevent install failures due to race conditions,
run the install command first with the `-l knative.dev/crd-install=true` flag,
then a second time without the selector flag. This installs the CRDs first:
```bash
kubectl apply --filename [FILE_URL]
```
- To install multiple components or plugins, append additional
`--filename [FILENAME]` flags to the `kubectl apply` command:
```bash
kubectl apply --filename [FILE_URL] --filename [FILE_URL] \
kubectl apply --selector knative.dev/crd-install=true \
--filename [FILE_URL] \
--filename [FILE_URL]
```
where [`FILE_URL`] is the URL path of the desired Knative release:
- Then run the `kubectl apply` command again without the `-l` flag to
complete the install:
```bash
kubectl apply --filename [FILE_URL] \
--filename [FILE_URL]
```
You can add as many `--filename [FILE_URL]` as needed.
[`FILE_URL`] is the URL path of the desired Knative release:
`https://github.com/knative/[COMPONENT]/releases/download/[VERSION]/[FILENAME].yaml`
@ -335,7 +339,16 @@ commands below.
**Example install commands:**
- To install the Knative Serving component with the set of observability
plug-ins:
plugins, enter the following command. The `--selector` flag
installs the CRDs first:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml
```
Then complete the install by running the command again, this time without
`--selector knative.dev/crd-install=true`:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -343,7 +356,20 @@ commands below.
```
* To install all three Knative components and the set of Eventing sources
without an observability plugin:
without an observability plugin, enter the following command. The
`--selector` flag installs the CRDs first:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
Then complete the install by running the command again, this time without
`--selector knative.dev/crd-install=true`:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -377,7 +403,7 @@ commands below.
See
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md)
for details about setting up the various supported observability plug-ins.
for details about setting up the various supported observability plugins.
You are now ready to deploy an app, run a build, or start sending and receiving
events in your Knative cluster.

24
docs/install/Knative-with-AKS.md
View File

@ -194,7 +194,23 @@ your Knative installation, see
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
1. Run the `kubectl apply` command to install Knative and its dependencies:
1. To install Knative, first install the CRDs by running the `kubectl apply`
command once with the `-l knative.dev/crd-install=true` flag. This prevents
race conditions during the install, which cause intermittent errors:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
1. To complete the install of Knative and its dependencies, run the
`kubectl apply` command again, this time without the `--selector`
flag, to complete the install of Knative and its dependencies:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -205,12 +221,6 @@ your Knative installation, see
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
> **Note**: If your install fails on the first attempt, try rerunning the
> commands. They will likely succeed on the second attempt. For background
> info and to track the upcoming solution to this problem, see issues
> [#968](https://github.com/knative/docs/issues/968) and
> [#1036](https://github.com/knative/docs/issues/1036).
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
> required to enable the Build and Serving components to interact with each
> other.

24
docs/install/Knative-with-GKE.md
View File

@ -204,7 +204,23 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
1. Run the `kubectl apply` command to install Knative and its dependencies:
1. To install Knative, first install the CRDs by running the `kubectl apply`
command once with the `-l knative.dev/crd-install=true` flag. This prevents
race conditions during the install, which cause intermittent errors:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
1. To complete the install of Knative and its dependencies, run the
`kubectl apply` command again, this time without the `--selector`
flag, to complete the install of Knative and its dependencies:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -215,12 +231,6 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
> **Note**: If your install fails on the first attempt, try rerunning the
> commands. They will likely succeed on the second attempt. For background
> info and to track the upcoming solution to this problem, see issues
> [#968](https://github.com/knative/docs/issues/968) and
> [#1036](https://github.com/knative/docs/issues/1036).
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
> required to enable the Build and Serving components to interact with each
> other.

24
docs/install/Knative-with-Gardener.md
View File

@ -130,7 +130,23 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
1. Run the `kubectl apply` command to install Knative and its dependencies:
1. To install Knative, first install the CRDs by running the `kubectl apply`
command once with the `-l knative.dev/crd-install=true` flag. This prevents
race conditions during the install, which cause intermittent errors:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
1. To complete the install of Knative and its dependencies, run the
`kubectl apply` command again, this time without the `--selector`
flag, to complete the install of Knative and its dependencies:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -141,12 +157,6 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
> **Note**: If your install fails on the first attempt, try rerunning the
> commands. They will likely succeed on the second attempt. For background
> info and to track the upcoming solution to this problem, see issues
> [#968](https://github.com/knative/docs/issues/968) and
> [#1036](https://github.com/knative/docs/issues/1036).
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
> required to enable the Build and Serving components to interact with each
> other.

24
docs/install/Knative-with-IKS.md
View File

@ -211,7 +211,23 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
1. Run the `kubectl apply` command to install Knative and its dependencies:
1. To install Knative, first install the CRDs by running the `kubectl apply`
command once with the `-l knative.dev/crd-install=true` flag. This prevents
race conditions during the install, which cause intermittent errors:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
1. To complete the install of Knative and its dependencies, run the
`kubectl apply` command again, this time without the `--selector`
flag, to complete the install of Knative and its dependencies:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -222,12 +238,6 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
> **Note**: If your install fails on the first attempt, try rerunning the
> commands. They will likely succeed on the second attempt. For background
> info and to track the upcoming solution to this problem, see issues
> [#968](https://github.com/knative/docs/issues/968) and
> [#1036](https://github.com/knative/docs/issues/1036).
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
> required to enable the Build and Serving components to interact with each
> other.

95
docs/install/Knative-with-Minikube.md
View File

@ -89,58 +89,73 @@ rerun the command to see the current status.
> command to view the component's status updates in real time. Use CTRL+C to
> exit watch mode.
## Installing Knative Serving
## Installing Knative
Next, install [Knative Serving](https://github.com/knative/serving):
The following commands install all available Knative components as well as the
standard set of observability plugins. To customize your Knative installation,
see [Performing a Custom Knative Installation](./Knative-custom-install.md).
Because you have limited resources available, install only the Knative Serving
component, omitting the other Knative components as well as the observability
and monitoring plugins.
1. If you are upgrading from Knative 0.3.x: Update your domain and static IP
address to be associated with the LoadBalancer `istio-ingressgateway` instead
of `knative-ingressgateway`. Then run the following to clean up leftover
resources:
If you are upgrading from Knative 0.3.x: Update your domain and static IP
address to be associated with the LoadBalancer `istio-ingressgateway` instead of
`knative-ingressgateway`. Then run the following to clean up leftover resources:
```
kubectl delete svc knative-ingressgateway -n istio-system
kubectl delete deploy knative-ingressgateway -n istio-system
```
```shell
kubectl delete svc knative-ingressgateway -n istio-system
kubectl delete deploy knative-ingressgateway -n istio-system
```
If you have the Knative Eventing Sources component installed, you will also
need to delete the following resource before upgrading:
If you have the Knative Eventing Sources component installed, you will also need
to delete the following resource before upgrading:
```
kubectl delete statefulset/controller-manager -n knative-sources
```
```shell
kubectl delete statefulset/controller-manager -n knative-sources
```
While the deletion of this resource during the upgrade process will not
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
While the deletion of this resource during the upgrade process will not prevent
modifications to Eventing Source resources, those changes will not be completed
until the upgrade process finishes.
1. To install Knative, first install the CRDs by running the `kubectl apply`
command once with the `-l knative.dev/crd-install=true` flag. This prevents
race conditions during the install, which cause intermittent errors:
Enter the following command:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
```shell
curl -L https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
| sed 's/LoadBalancer/NodePort/' \
| kubectl apply --filename -
```
1. To complete the install of Knative and its dependencies, run the
`kubectl apply` command again, this time without the `--selector`
flag, to complete the install of Knative and its dependencies:
Monitor the Knative components until all of the components show a `STATUS` of
`Running`:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
```shell
kubectl get pods --namespace knative-serving
```
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
> required to enable the Build and Serving components to interact with each
> other.
Just as with the Istio components, it will take a few seconds for the Knative
components to be up and running; you can rerun the command to see the current
status.
> Note: Instead of rerunning the command, you can add `--watch` to the above
> command to view the component's status updates in real time. Use CTRL+C to
> exit watch mode.
Now you can deploy an app to your newly created Knative cluster.
1. Monitor the Knative components until all of the components show a `STATUS` of
`Running`:
```bash
kubectl get pods --namespace knative-serving
kubectl get pods --namespace knative-build
kubectl get pods --namespace knative-eventing
kubectl get pods --namespace knative-sources
kubectl get pods --namespace knative-monitoring
```
## Deploying an app

9
docs/install/Knative-with-Minishift.md
View File

@ -172,10 +172,11 @@ curl -s https://raw.githubusercontent.com/knative/docs/master/docs/install/scrip
> **NOTE:** It will take a few minutes for all the components to be up and
> running.
### Install Knative Serving
### Install Knative
The following section details on deploying
[Knative Serving](https://github.com/knative/serving) to OpenShift.
The following commands install the Knative Serving and Build components on
OpenShift. To customize your Knative installation, see
[Performing a Custom Knative Installation](./Knative-custom-install.md).
The [knative-openshift-policies.sh](./scripts/knative-openshift-policies.sh)
runs the required commands to configure necessary privileges to the service
@ -213,7 +214,7 @@ curl -s https://raw.githubusercontent.com/knative/docs/master/docs/install/scrip
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
1. Install Knative serving:
1. Install Knative Serving and Build:
```shell
oc apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml && \

24
docs/install/Knative-with-PKS.md
View File

@ -104,7 +104,23 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
1. Run the `kubectl apply` command to install Knative and its dependencies:
1. To install Knative, first install the CRDs by running the `kubectl apply`
command once with the `-l knative.dev/crd-install=true` flag. This prevents
race conditions during the install, which cause intermittent errors:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
1. To complete the install of Knative and its dependencies, run the
`kubectl apply` command again, this time without the `--selector`
flag, to complete the install of Knative and its dependencies:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -115,12 +131,6 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
> **Note**: If your install fails on the first attempt, try rerunning the
> commands. They will likely succeed on the second attempt. For background
> info and to track the upcoming solution to this problem, see issues
> [#968](https://github.com/knative/docs/issues/968) and
> [#1036](https://github.com/knative/docs/issues/1036).
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
> required to enable the Build and Serving components to interact with each
> other.

24
docs/install/Knative-with-any-k8s.md
View File

@ -83,7 +83,23 @@ your Knative installation, see
prevent modifications to Eventing Source resources, those changes will not be
completed until the upgrade process finishes.
1. Run the `kubectl apply` command to install Knative and its dependencies:
1. To install Knative, first install the CRDs by running the `kubectl apply`
command once with the `-l knative.dev/crd-install=true` flag. This prevents
race conditions during the install, which cause intermittent errors:
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
--filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \
--filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \
--filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \
--filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
1. To complete the install of Knative and its dependencies, run the
`kubectl apply` command again, this time without the `--selector`
flag, to complete the install of Knative and its dependencies:
```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \
@ -94,12 +110,6 @@ your Knative installation, see
--filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
```
> **Note**: If your install fails on the first attempt, try rerunning the
> commands. They will likely succeed on the second attempt. For background
> info and to track the upcoming solution to this problem, see issues
> [#968](https://github.com/knative/docs/issues/968) and
> [#1036](https://github.com/knative/docs/issues/1036).
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
> required to enable the Build and Serving components to interact with each
> other.

4
docs/install/README.md
View File

@ -69,6 +69,7 @@ available Knative components and a set of observability plugins.
- [Knative Install on Google Kubernetes Engine](./Knative-with-GKE.md)
- [Knative Install on IBM Cloud Kubernetes Service](./Knative-with-IKS.md)
- [Knative Install on IBM Cloud Private](./Knative-with-ICP.md)
- [Knative Install on Minikube](./Knative-with-Minikube.md)
- [Knative Install on Pivotal Container Service](./Knative-with-PKS.md)
If you already have a Kubernetes cluster you're comfortable installing _alpha_
@ -82,10 +83,9 @@ The guides below install some of the available Knative components, without all
available observability plugins, to minimize the disk space used for install.
- [Knative Install on Docker for Mac](./Knative-with-Docker-for-Mac.md)
- [Knative Install on Minikube](./Knative-with-Minikube.md)
- [Knative Install on Minishift](./Knative-with-Minishift.md)
- [Knative Install on OpenShift](./Knative-with-OpenShift.md)
- [Knative Install via Operator](https://github.com/openshift-cloud-functions/Documentation/blob/master/knative-OCP-4x.md)
- [Knative Install on OpenShift via Operator](https://github.com/openshift-cloud-functions/Documentation/blob/master/knative-OCP-4x.md)
**Custom install guide**