Format markdown (#1556)

Produced via:
  `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
/assign @samodell
This commit is contained in:
mattmoor-sockpuppet 2019-06-28 07:59:07 -07:00 committed by Knative Prow Robot
parent a886c2eaba
commit d0bd1ffe9b
1 changed files with 47 additions and 21 deletions

View File

@ -7,47 +7,70 @@ type: "docs"
# Knative Install on OpenShift # Knative Install on OpenShift
This guide walks you through the installation of the latest version of [Knative This guide walks you through the installation of the latest version of
Serving](https://github.com/knative/serving) on [OpenShift](https://github.com/openshift/origin) by using the Knative Serving Operator. The operator is available on the OpenShift OperatorHub. After you install Knative Serving, this guide walks you through creating and deploying an image of a sample "Hello World" app onto the new Knative cluster. [Knative Serving](https://github.com/knative/serving) on
[OpenShift](https://github.com/openshift/origin) by using the Knative Serving
Operator. The operator is available on the OpenShift OperatorHub. After you
install Knative Serving, this guide walks you through creating and deploying an
image of a sample "Hello World" app onto the new Knative cluster.
You can find [guides for other platforms here](./README.md). You can find [guides for other platforms here](./README.md).
## Before you begin ## Before you begin
* An OpenShift 4 cluster is required for installation. Visit [try.openshift.com](https://try.openshift.com) for information on setting up a cluster. You will need cluster administrator privileges to install and use Knative on an OpenShift cluster. - An OpenShift 4 cluster is required for installation. Visit
[try.openshift.com](https://try.openshift.com) for information on setting up a
cluster. You will need cluster administrator privileges to install and use
Knative on an OpenShift cluster.
## Installing the Knative Serving Operator ## Installing the Knative Serving Operator
1. Go to **Catalog > OperatorHub** in the [OpenShift Web Console](https://www.openshift.com/). A list of operators for OpenShift, provided by Red Hat as well as a community of partners and open-source projects is provided. Click on the **Knative Serving Operator** tile. 1. Go to **Catalog > OperatorHub** in the
[OpenShift Web Console](https://www.openshift.com/). A list of operators for
OpenShift, provided by Red Hat as well as a community of partners and
open-source projects is provided. Click on the **Knative Serving Operator**
tile.
> **NOTE:** Use the **Filter by Keyword** box to help you find the Knative Serving operator in the catalog. > **NOTE:** Use the **Filter by Keyword** box to help you find the Knative
> Serving operator in the catalog.
![KSO Tile](images/knative_serving_tile_highlighted.png) ![KSO Tile](images/knative_serving_tile_highlighted.png)
2. A **Show Community Operator** dialog box will open. Click **Continue** to proceed. 2. A **Show Community Operator** dialog box will open. Click **Continue** to
proceed.
3. The **Knative Serving Operator** descriptor screen will appear. Click **Install**. 3. The **Knative Serving Operator** descriptor screen will appear. Click
**Install**.
![KSO Install Screen](images/knative_serving_operator_screen.png) ![KSO Install Screen](images/knative_serving_operator_screen.png)
4. On the **Create the Operator Subscription** screen, create a new subscription by clicking on the **Subscribe** button. This will install the Knative Serving Operator in the project `openshift-operators` and Knative Serving in the `knative-serving` project. 4. On the **Create the Operator Subscription** screen, create a new subscription
by clicking on the **Subscribe** button. This will install the Knative
Serving Operator in the project `openshift-operators` and Knative Serving in
the `knative-serving` project.
![KSO Namespaces Default](images/knative_serving_namespaces_default.png) ![KSO Namespaces Default](images/knative_serving_namespaces_default.png)
> **NOTE:** The Operator Lifecycle Manager (OLM) installs the operator, which will automatically install Knative. This installation will create the `knative-serving`, `istio-operator`, and `istio-system` namespaces. > **NOTE:** The Operator Lifecycle Manager (OLM) installs the operator, which
> will automatically install Knative. This installation will create the
> `knative-serving`, `istio-operator`, and `istio-system` namespaces.
5. Verify the subscription status for the installation operator, by viewing the **Subscription Overview**. The **UPGRADE STATUS** will update from **0 Installing** to **1 Installed**. 5. Verify the subscription status for the installation operator, by viewing the
**Subscription Overview**. The **UPGRADE STATUS** will update from **0
Installing** to **1 Installed**.
> **NOTE:** The screen will update after a few minutes. Wait for the `knative-serving` namespace to appear in the project drop-down menu. Refresh the page if needed. > **NOTE:** The screen will update after a few minutes. Wait for the
> `knative-serving` namespace to appear in the project drop-down menu. Refresh
> the page if needed.
![KSO Upgrade Status](images/knative_serving_installed_sub.png) ![KSO Upgrade Status](images/knative_serving_installed_sub.png)
6. Knative Serving is now installed. Navigate to **Catalog > Installed Operators** to confirm the operator is installed. Click on **knative-serving** to view the install status. 6. Knative Serving is now installed. Navigate to **Catalog > Installed
Operators** to confirm the operator is installed. Click on
**knative-serving** to view the install status.
![KSO installed](images/knative_serving_installed_operator.png) ![KSO installed](images/knative_serving_installed_operator.png)
## Deploying an app ## Deploying an app
Now that your cluster has Knative installed, you're ready to deploy an app. Now that your cluster has Knative installed, you're ready to deploy an app.
@ -60,10 +83,10 @@ guide.
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/README.md) repo. head to the [sample apps](../serving/samples/README.md) repo.
> **NOTE:** When looking up the IP address to use for accessing your app, you need > **NOTE:** When looking up the IP address to use for accessing your app, you
> to look up the NodePort for the `istio-ingressgateway` well as the IP address > need to look up the NodePort for the `istio-ingressgateway` well as the IP
> used for OpenShift. You can use the following command to look up the value to > address used for OpenShift. You can use the following command to look up the
> use for the {IP_ADDRESS} placeholder used in the samples: > value to use for the {IP_ADDRESS} placeholder used in the samples:
```shell ```shell
# In Knative 0.2.x and prior versions, the `knative-ingressgateway` service was used instead of `istio-ingressgateway`. # In Knative 0.2.x and prior versions, the `knative-ingressgateway` service was used instead of `istio-ingressgateway`.
@ -89,13 +112,16 @@ export IP_ADDRESS=$(oc get node -o 'jsonpath={.items[0].status.addresses[0].add
> **NOTE:** The operator tile will indicate it is installed. > **NOTE:** The operator tile will indicate it is installed.
3. The **Show Community Operator**` dialog box will appear. Click **Continue** to proceed. 3. The **Show Community Operator**` dialog box will appear. Click **Continue**
to proceed.
4. Once the **Knative Serving Operator** descriptor screen appears, click **Uninstall**. 4. Once the **Knative Serving Operator** descriptor screen appears, click
**Uninstall**.
![KSO Uninstall](images/knative_serving_uninstall_operator.png) ![KSO Uninstall](images/knative_serving_uninstall_operator.png)
5. Select **Also completely remove the Operator from the selected namespace**, in the **Remove Operator Subscription** dialog box. 5. Select **Also completely remove the Operator from the selected namespace**,
in the **Remove Operator Subscription** dialog box.
6. Click **Remove**. 6. Click **Remove**.