Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CONSOLE-2472: Add initial quick starts
- Loading branch information
Showing
8 changed files
with
423 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributing Quick Starts | ||
|
||
Quick starts walk users through completing different tasks in the console. In | ||
OpenShift 4.7, we added a | ||
[quick start custom resource](https://github.com/openshift/enhancements/blob/master/enhancements/console/quick-starts.md). | ||
This allows operators and administrators to contribute new quick starts to the | ||
cluster beyond the out-of-the-box set. Typically, quick starts for operators are | ||
created by the operator itself after the operator is installed. In a few cases, | ||
we have out-of-the-box quick starts that guide administrators through the | ||
process of installing an operator. These need to be created before operator | ||
installation through OperatorHub. Any out-of-the-box quick start should be | ||
contributed to the `quickstarts` folder here in the console-operator repo. | ||
|
||
To contribute out-of-the-box quickstarts, follow the | ||
[guidelines](http://openshift.github.io/openshift-origin-design/conventions/documentation/quick-starts.html) | ||
for writing a quick start and getting the content reviewed. When the | ||
quick start is ready, add the quick start YAML to this folder and open a PR. | ||
Request review from `@jhadvig` and `@spadgett` on the PR. | ||
|
||
## Quick Start API | ||
|
||
To see the quick start API documentation, you can use the `oc explain` command. | ||
|
||
``` | ||
$ oc explain consolequickstarts | ||
``` | ||
|
||
Check `oc explain -h` for more details on `oc explain`. | ||
|
||
Details about the API are also covered in the | ||
[quick start enhancement proposal](https://github.com/openshift/enhancements/blob/master/enhancements/console/quick-starts.md). | ||
|
||
## Updating Quick Starts in Previous Releases | ||
|
||
The console-operator repo has branches for each OpenShift release. The `master` | ||
branch tracks the next unreleased minor (`y` version) of OpenShift. Releases | ||
that have already shipped are tracked through branches like `release-4.6`. If | ||
you need to backport a quick start change to a previous release, you will need | ||
to a Bugzilla bug. The `/cherry-pick` bot command will automatically create a | ||
new Bugzilla if the `master` PR had a Bugzilla attached. See the notes on | ||
[backporting fixes](https://github.com/openshift/console/blob/master/CONTRIBUTING.md#backporting-fixes) | ||
in the openshift/console contributing guide. | ||
|
||
Avoid changing the resource name of existing quick starts. This will cause | ||
duplicate quick starts to show up when upgrading from one release to the next as | ||
the ClusterVersionOperator will not delete the old quick start with the previous | ||
name. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
apiVersion: console.openshift.io/v1 | ||
kind: ConsoleQuickStart | ||
metadata: | ||
name: add-healthchecks | ||
spec: | ||
version: 4.7 | ||
displayName: Adding health checks to your sample application | ||
durationMinutes: 10 | ||
icon: '' | ||
description: You just created a sample application. Now, let’s add health checks | ||
to it. | ||
prerequisites: [You completed the "Getting started with a sample" quick start.] | ||
introduction: |- | ||
### This quick start shows you how to add health checks to your sample application. | ||
You should have previously created the **sample-app** application and **nodejs-sample** deployment using the **Get started with a sample** quick start. If you haven't, you may be able to follow these tasks with any existing deployment without configured health checks. | ||
tasks: | ||
- title: Viewing the details of your sample application | ||
description: |- | ||
### To view the details of your sample application: | ||
1. Go to the project your sample application was created in. | ||
2. In the **</> Developer** perspective, go to **Topology**. | ||
3. Click on the **nodejs-sample** deployment to view its details. | ||
A side panel is displayed containing the details of your sample application. | ||
review: | ||
instructions: |- | ||
#### To verify you are viewing the details of your sample application: | ||
Is the side panel titled **nodejs-sample**? | ||
failedTaskHelp: This task isn’t verified yet. Try the task again. | ||
summary: | ||
success: You have viewed the details of your sample app! | ||
failed: Try the steps again. | ||
- title: Verifying that there are no health checks | ||
description: |- | ||
### To verify that there your sample application has no health checks configured: | ||
1. View the information in the **Resources** tab in the side panel. | ||
review: | ||
instructions: |- | ||
#### To verify there are no health checks configured: | ||
Do you see an inline alert stating that **nodejs-sample** does not have health checks? | ||
failedTaskHelp: This task isn’t verified yet. Try the task again. | ||
summary: | ||
success: You have verified that there are no existing health checks! | ||
failed: Try the steps again. | ||
- title: Adding health checks to your sample | ||
description: |- | ||
### To add health checks to your sample: | ||
1. Add health checks to your **nodejs-sample** deployment in one of the following ways: (a) On the side panel, click on the **Actions** menu, where you will see an **Add Health Checks** menu item or (b) Click on the **Add Health Checks** link on the inline notification in the side panel. | ||
2. In the Add Health Checks form, click on the **Add Readiness Probe** link. Leave the default values, and click on the check to add the Readiness Probe. | ||
3. Click on the **Add Liveness Probe** link. Leave the default values, and click on the check to add the Liveness Probe. | ||
4. Click on the **Add Startup Probe** link. Leave the default values, and click on the check to add the Startup Probe. | ||
5. Click **Add** when you’re done. | ||
You will be brought back to the Topology View. | ||
review: | ||
instructions: |- | ||
#### Verify that health checks are now configured: | ||
Is the inline notification gone? | ||
failedTaskHelp: | ||
This task isn’t verified yet. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/applications/application-health.html#odc-adding-health-checks) | ||
about this topic. | ||
summary: | ||
success: You have added health checks to your sample app! | ||
failed: Try the steps again. | ||
conclusion: Your sample application now has health checks. To ensure that your application | ||
is running correctly, take the **Monitor your sample application** quick start. | ||
nextQuickStart: [monitor-sampleapp] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
apiVersion: console.openshift.io/v1 | ||
kind: ConsoleQuickStart | ||
metadata: | ||
name: explore-pipelines | ||
spec: | ||
version: 4.7 | ||
displayName: Installing the Pipelines Operator | ||
durationMinutes: 10 | ||
icon: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGUAAABlCAYAAABUfC3PAAAQrElEQVR4Xu2dd3wU1RbHfymkQBomkAYEiICCSFDkw3uACaIi0mJBKT4JRgSehSAoyEMMykMUpfgBBaSEjw8BfX4oL4ogQmjqB5CignQSSgrpZdOTeZ8zYdbdzczO3dm5uxtx/oLMnXvPOd97bj33rhuawFOTeVmoPnsC1edOoC4rHbWZ6aLU9P/6smJZDTzDo+AZ3l58531vHNz9g+DVOQa+vQa4ubrKLilg1dnjQnnaVlT9nGbV8FqNS8AIEMFqHhePZhEdXMoOLiOMYe8WoWLfVhAMpdqvFYLadwTJNzYefsMS4N2lp9Nt4lQBqFkq+XwJDKkpDgehBIoA+Y9OQuCYqU6zjVMKrji6VyhelYzKY/vUKrFT3/sNHYfAF5Id3rw5FEpTgWFZExwNxyFQqOMu/DDJ5T1DzS39R01B8PSl3G3GvYD8D6YIpZuWqunbZN67+wWKTRrPPocbFGqq8ucmoDYro8kY3BZBfe6JRXByCpf+hguUP5t3KMEir2k5bQn8h43X1Y66ZkZD3Nxp8ag+f9KWStfk09JAICR5vW621C0jaq5yp8e7zHzD0aS9OvVAxMaTuthTl0xK/7dOyJ873tF2cLnyaOLZ6oOtdq8K2A3lLyDmdYP6mdCVaXaBsQvKX0DkndWtRQCC522EX/8hmuyr6SMSxVWA0PK8z71x8IxoWKan5fzKn9NQX1rklOZNAFBSA9TDDR3f34jAQaNstrHNH7gKEFp6p+EozRfkHpqwFq1KdigcCUgd/QOAm5s2MDZDoSX23Ncec0otlAr1G5qA4LfWqcpQdeFX5E4dirrsK6pp7U1gCUTKz8PTEz2O1dpkZ5sS0xpWzsQ4pw57yUPCNxxXtaEgCCgpKYFQVYniIWGq6e1JoAREyrOZjy+6H65gtjVzQiogc3QPwdkTQxrZKDVZkhEkIHV1dQ3NyO+HUZI02B67K36rBkT6sEW7aHRJvchkb6ZElPGNaSOE8n3buCjGmimLl1gCobzdhXoUP9KKtRjmdKxApAwjE2cidMoCVZurJnCVjp3kCBidhJavLlautTebLMlDTBNWTh+Gml9/YDa4WkJbgUgdf+eU/WjRs79Vu6tCofWsrDExTu1HJAMF0ZL5hLdk7SXnIaYJa1fPQcWXy9VszfReCxApY++AIHQ7WGQfFGc3W7R0EZj4Jnz7DoFHiHyHrQaEDOLv1wJuN66h9ItlKNm4hMn4consASLlF/p4IiKT1yiCsUrMmcNf7x79EJKcAs/IjhCqK1Hx407UXD6NwPGzzGzFAkRsOjYvRouBT8Ar+i7x+/IDqShclGTTfo8eQKRmrOdJQRuUa8OiBEdvUpFnhH78PTzbRKP22kUUfPAKKg59IxqSZu+R2y8bobACsezoW770LvyemAT3FoGgwQvLvEsvIJLwAXfG4PbNJ2TBKNIq/nyxULhoqmY31/Jhq4Vb0Dx2BGpvXEPev8ag6uTBRtkEv5UC2r9gBUIZCLs3oWzhi43yooFD0Ivzxb8XLZ9l1qzRBNWrSwwKPkyC3kAkQbqsPyDb6StCuRIXKDgqKI68IzzlMNwDb0Ph0testvkUfhqxPR1ldYDcKMvS8u6VBhSPaGe1joR+9C18/jYIVcf2IXtiHKQVA5qTZY6JEdeypKUTLZVN6RuluYssFN5eIi0iUk30+ftgNGvXGbWZl5EzaQBTG+/9wJPwnrFSrMHWHvfaGpQl9mZaZmnx0NM3l24EuHk3N2b7S4wbFyDWvEUWCo++hEBQFIi4ohse1ciW1K5TyCrr4xHWDn4Lt0No3bYRHFEpDbP4215dLEZHmj7nEweg7Ggaq1g2p5PzlkZQeC7JS/2BnOQZ96lOmRQV9h35IjzadxXf16Wf1jQfUZIte8VcZH2SbLOxWT+glWTLkVgjS2S/ECvwDCeVU14cAU2PZ9VD93TWVp0NJw7h3Lh+updpmmHwwHhELd5qZGEGhWbv14d34CoAzT/CVh8wK4P298tSU7iWq5Y5DSAo8t4rNh4BcSOMyYW6Wpy4p5na53a9t1xFNoPCu4MnydsdLBcP/dQV3jCu9lJFqM1qOAjkrMdy2Bv4QDxaPvwUgh58AqU/7MTFV4ZzFS164SbjLqUZFN5L82Er0+DVrTeu9GsunqyiZXh6aG3NmY+1eUhAv0cRvfxrpL8+CoU7N3MT03QyaYTCu+ny7fsoWi/5GnmzRsHwXYNy0pE32lN31sMyMey0Jg3Nu/fGyd5/DJX1lte0CTNC4d10td1biJpzJ8XJmas8LEAkWWOOVqEg9TNcSX6em/jSDN8IhedqsLgPMnURro+gvsM1Ar5tAUIUWo1NQpvXFuHU4A6o5qSDtHpshMJzWcXVvMRWIJJr3H2wEEW7v+LmLdJEUoRCARFZY3tycUtxCPzpfpfxEq1AyDhtZn6EkKcmcxsiS5EvIhSes3iKPHFv7o/rj93OBbotmdoDxNi3HKtBxhvPcBuJ3fML3EQohSvfEoo/nWuLfsxpo36qQf6CySjbupr5Gx4J9QBCct2xuSG86czTfFqWqBmLIULRe2mFFh8pjNSn1wBxKzejtzsPOzPnqRcQKjD0uRkIf/nfuDDhQbF8vRcraclFhKLXpJFub6CVYDqrYfmUpa4HHdN29MxdLyB+veIQPjkZfr0ah8kWbF8vLlpW37yehLm2yCRseV9sA5T0XqpbE6rlWFsBlj6mTbOcpKGoltlRVC1AQwK9gLR5fQlajZ1iVYK6smJkrngbeZ8t0iDpH59QtIsuUFiAULFVVVUoNxhQ9d5EVO35r13Cq32sFxDyjrBJ8mFNpjKQbgaDASUr5qBws/ZQJhEKHYujHT+tD21aha7Yq/q5JDQlpB1BnvG9egHximiPbjv+CNRQUtJUNzehHukPaI/G1AUKHSejYAdrj6nQUjo9g+NMy9YLCOUZ9U4Kbhs+zmbdKndtQs67jQM1VGvuzQR2e0rUEes75XJAqGweQdd6AiEZu32bDi+ZrWvJuEq64cZVZDytfeWbKxRFoakJY4gyYa1ZlE5vIJRnz5PKFc6abm6VBqQPth5BY003blCsCS32KzpC4QHEGhQ13VwSiprQIpQrZ1A8oa8tziCblhcQpeaLRTe34nykx3fWrJvdnmLZ0bMILTY3ClGLtmjCE4hcR8+qW81Pu5D5xmhbVDFLazcUmsVTuCk9rELrcYiHNxDSh2bxndY0DPdZdaOJ3/XRPVGj8Zwl7UDqMnkkb/Ho84g4eWJ56r9aBsMq9QmZUl6OACKVTbP5gCcnMetmr5foNqOnvXb/TWdQ76keimNvs+VIIBKYqA1HgIiO6vXNzqEwFWCEoleYasCSHcCdvWUX0qjJql6TrCl6UbKGM4AYPWbZDnh2k9eNZvFlX36MvE+0e79UDkW16L50TzG+vv+YAffIjvBs3UY89FO67HW7YPCah6hXffMUzcLaofXL8+E/8HGUHW24lLTy1GFdYEglGVeJeV6aFnW4HtkT7pc9a8JqFGd6iKWMHRdvgU+n7jg9lM9OqnGTi2d4UeSWC6gvykPW+D6sDMzSuRIQEqzH4XLkbliKzKVvaNJH7SMKMxKbL3tXiq0VJIYXTVmIjD7qgwDLfFwNSPDjz6PdnFU4HsNnJ1WKwDeGGOmx0aUEh/bpaecxfx57IJurASHduqZeQE3ONZxP5BNQ6NMqDF2/z24InKBH7316U0DBs1eL5xRZvcUVgbTo2Q+dUw7gXEJ/GI43Poup1iyxvJeORBih8IxoIYFYvcUVgZD83fflovLCKW5eQmVIkfdGKDwD8qhAltBVVwFCO46mQRBhL8xG+D/f5hqyanoFldlRCL0mkUqu2mZHlvjq2uDwRklcBYiHfxAoPPXS1MdQvGeruMnVbccl5Kx7n9uIi4xhevbRDArP+QoVTAdQI7ZcQNXRvSheN1+8VpAeVwFCstBhIZqLUHTK+efiEP3xDlHG3wY2rkgs/QRrGtMbjsyg8G7CRKUTZyNo0juirBRyRCeCCw+noXDPVtQ56d5HU8OZ7svT0ToKIj39aDS3SHsq2/L2vEYHUXk3YbR42XZPoWwFKt67DdfeT9IlqI21hlqmu/tQETz8Ao1/rq8sx7ln+6Li7AmtWap+Z3klSCMoPGf3knSR29Nlz9JTpGHGmwmqSvBKYLp/YloGNWVnRsZwqyyW14HIHl7neVaFlJUL3suYMx4F22w7IUydcvCIBHEziv5ND9Xo0qNpYidt62MtEpJXhZEmjKayykLh2eFTp+4xOAFt3za/LTV/yxqbDuO0fiYJYZOTzZoaU8XotNWlKfHMzQ5Bveu7q3D39ROzoVVgCt4uP3sCZUfSuPV3tAAZPNb8979kofA6lCqNsuguyDu+aDhSQB7i4RckHl2ryc/BuWf6qHaqLEFyoteUFCFn2WzVMFJa02o7azlqC/Nw9Z2JKN6faquTaUqvdEueLBQqQW9vsRz2UqAbdepSM0Pzgc7/+QnNgkNR+O0mpM8cI6uoNGRVs4K0p25tz5zK7LhkK3y79EDpj7twYfIjatnq+l7OS6gARSj0Uq++RW4eQs2F3BCYDnxGTlsoKk/tuOVpXLWoRfquUZCDxTYtwYiatx5+994veufl6SO5rWcpUbR2l6RVKHqsh2mdGLZLXm2M4608/xty1i4QDShFlygpKxd1QkqmDwhGxJR3EfTQSHi3jUZNXjZy1r6H3A3a75O0x22ULmBT9RRKYM+BIq1ATJUlz2k1+iV4t6HABQFwU97LsBYGFBgQAHc3wHD8EDKXzXa4Z5jqRFu+HdbsU3QIq54idpYaj0roAcSyJnb8aDsCY4fJVlC1uKyq1BRkfzjNnsqty7csd9+rQtHS6fMAQnIoHeBRA0Lf2nuYRxcitIUhMwS2zJsJii3NGC8gJIPcyIsFSIP82qMW9QKi1mxJ5TBDYflFCJ5ASGAasdHoS1qbYgVib8C1HlBs+WUIZigkmLXLo3kDkQwjNWGsQFyh6ZK7ktAaaJugUEZyw2RHAZEU6bTtLKoDQpgqsJB+BlfG23/kgqkwmURafm3IZihUbl7yOIGiU+hxNBAqkyIVI1fshhAYbNVWdacO49pLfH43hRWS2r32cvlogiKBKU1dz+0iZRalQybPhd+g0WZwSCHhxlUUfDoPpbv5HgtXk1ELEMpTMxT6+OJTPYTiM7fWT9KqgZDeawViNxTK4OzQaMFw5SKrrLdEOnuA6ALlLzDm9cxeILpBoYwuJ8YKhUcajgfcio+WUZaSnezqUywzzVk6U8hc+574Mxq30kMTw44rd6n+1harTXSFQoUajh8QLk18GDWVFawyNOl0tvxUIKuiukORCv6zN2fUXEU8N4PpJwJZYUjpuEGhAop3bhKuvDn+T+c1chEothreWnquUKSCM6bGCwV7tjX5vob6jogp8xtFn+gJRNfRF4tg1KQVHd3f5ODQxlTI8HFWfwaQRX/WNA7xFEthmgocR8NwSJ+iVjOuJycKBd987nJ9DvUZwcMTuHTiajZxePOlJBANCHLXLoDh/G+oq61lkVv3NNRfBPQdhJBnp+k239AqpFOaL2vCEqCCLz5B+dmTqCop0qqX6nc0pPUOCUVg/yEIGpHgdBCmArscFEtrEqSyH79Dxe8/o+p6OmrLy2z2JvG+E28f+LbvguZ3/w1+9w9xKQiWOrs8FDWvqs1rOLJn+fh07eXShrem1/8BWjy0OmdfIfEAAAAASUVORK5CYII= | ||
description: Install the OpenShift® Pipelines Operator to build Pipelines using | ||
Tekton. | ||
prerequisites: [''] | ||
introduction: |- | ||
OpenShift® Pipelines is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses Tekton building blocks to automate deployments across multiple Kubernetes distributions by abstracting away the underlying implementation details. | ||
* OpenShift Pipelines is a serverless CI/CD system that runs pipelines with all the required dependencies in isolated containers. | ||
* They are designed for decentralized teams that work on a microservice-based architecture. | ||
* They are defined using standard Custom Resource Definitions making them extensible and easy to integrate with the existing Kubernetes tools. This enables you to scale on-demand. | ||
* You can use OpenShift Pipelines to build images with Kubernetes tools such as Source-to-Image (S2I), Buildah, Buildpacks, and Kaniko that are portable across any Kubernetes platform. | ||
* You can use the Developer perspective to create and manage pipelines and view logs in your namespaces. | ||
To start using Pipelines, install the OpenShift® Pipelines Operator on your cluster. | ||
tasks: | ||
- title: Installing the OpenShift Pipelines Operator | ||
description: "### To install the OpenShift Pipelines Operator:\n\n1. From the | ||
**Administrator** perspective in the console navigation panel, click **Operators | ||
> OperatorHub**.\n2. In the **Filter by keyword** field, type `OpenShift Pipelines | ||
Operator`.\n3. If the tile has an Installed label, the Operator is already installed. | ||
Proceed to the next quick start to create a Pipeline.\n4. Click the **tile** | ||
to open the Operator details.\n5. At the top of the OpenShift Pipelines Operator | ||
panel that opens, click **Install**.\n6. Fill out the Operator subscription | ||
form by selecting the channel that matches your OpenShift cluster, and then | ||
click **Install**.\n7. On the **Installed Operators** page, wait for the OpenShift | ||
Pipelines Operator's status to change from **Installing** to **Succeeded**. " | ||
review: | ||
instructions: |- | ||
#### To verify that the OpenShift Pipelines Operator is installed: | ||
1. From the **Operators** section of the navigation, go to the **Installed Operators** page. | ||
2. Verify that the **OpenShift Pipelines Operator** appears in the list of Operators. | ||
In the status column, is the status of the OpenShift Pipelines Operator **Succeeded**? | ||
failedTaskHelp: | ||
This task isn’t verified yet. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/pipelines/installing-pipelines.html#op-installing-pipelines-operator-in-web-console_installing-pipelines) | ||
about this topic. | ||
summary: | ||
success: You have installed the Pipelines Operator! | ||
failed: Try the steps again. | ||
conclusion: You successfully installed the OpenShift Pipelines Operator! If you | ||
want to learn how to deploy an application and associate a Pipeline with it, take | ||
the Creating a Pipeline quick start. | ||
nextQuickStart: [install-app-and-associate-pipeline] | ||
accessReviewResources: | ||
- group: operators.coreos.com | ||
resource: operatorgroups | ||
verb: list | ||
- group: packages.operators.coreos.com | ||
resource: packagemanifests | ||
verb: list |
Oops, something went wrong.