### Quick Start Introduction Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/adding-user-preferences Write clear and friendly introductions that state the outcome of the quick start and guide the user. ```text In this quick start, you will deploy a sample application to {product-title}. ``` -------------------------------- ### Example Output for Install Plan Name Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/scalability_and_performance This is an example of the install plan name that will be outputted. ```text install-dt54w ``` -------------------------------- ### Quick Start Introduction Examples Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/web_console State the outcome of the quick start and give action to the user. The first example is correct, while the second is incorrect. ```text In this quick start, you will deploy a sample application to {product-title}. ``` ```text This quick start shows you how to deploy a sample application to {product-title}. ``` -------------------------------- ### Example: List Parameters for a Quick Start Template Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/building_applications/creating-applications This example demonstrates listing parameters for the `rails-postgresql-example` quick start template in the `openshift` project. ```bash $ oc process --parameters -n openshift rails-postgresql-example ``` -------------------------------- ### GET /apis/console.openshift.io/v1/consolequickstarts Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/console_apis/consolequickstart-console-openshift-io-v1 Lists all ConsoleQuickStart objects. This endpoint retrieves a list of all available quick start guides. ```APIDOC ## GET /apis/console.openshift.io/v1/consolequickstarts ### Description Lists objects of kind ConsoleQuickStart. ### Method GET ### Endpoint /apis/console.openshift.io/v1/consolequickstarts ### Response #### Success Response (200) - **ConsoleQuickStartList** (ConsoleQuickStartList schema) - A list of ConsoleQuickStart objects. #### Error Response - **401 - Unauthorized** - Returned when the request lacks valid authentication credentials. ``` -------------------------------- ### Example output of 'make install' Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/operators/developing-operators This is an example of the output you might see after running the 'make install' command, indicating the creation of a custom resource definition. ```bash /usr/bin/kustomize build config/crd | kubectl apply -f - customresourcedefinition.apiextensions.k8s.io/memcacheds.cache.example.com created ``` -------------------------------- ### Example Output of Initial Operator Installation Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/operators/developing-operators This is an example of the output you can expect when initially installing an Operator using the `run bundle` subcommand. It shows the creation of catalog sources, subscriptions, and the Operator's installation progress. ```bash INFO[0006] Creating a File-Based Catalog of the bundle "quay.io/demo/memcached-operator:v0.0.1" INFO[0008] Generated a valid File-Based Catalog INFO[0012] Created registry pod: quay-io-demo-memcached-operator-v1-0-1 INFO[0012] Created CatalogSource: memcached-operator-catalog INFO[0012] OperatorGroup "operator-sdk-og" created INFO[0012] Created Subscription: memcached-operator-v0-0-1-sub INFO[0015] Approved InstallPlan install-h9666 for the Subscription: memcached-operator-v0-0-1-sub INFO[0015] Waiting for ClusterServiceVersion "my-project/memcached-operator.v0.0.1" to reach 'Succeeded' phase INFO[0015] Waiting for ClusterServiceVersion ""my-project/memcached-operator.v0.0.1" to appear INFO[0026] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.1" phase: Pending INFO[0028] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.1" phase: Installing INFO[0059] Found ClusterServiceVersion "my-project/memcached-operator.v0.0.1" phase: Succeeded INFO[0059] OLM has successfully installed "memcached-operator.v0.0.1" ``` -------------------------------- ### Get ConsoleQuickStart YAML Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/adding-user-preferences Use this command to retrieve a YAML definition of an existing ConsoleQuickStart, which can then be modified to create a new quick start. Requires cluster administrator privileges. ```bash $ oc get -o yaml consolequickstart spring-with-s2i > my-quick-start.yaml ``` -------------------------------- ### View Example Installation Log Output Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/validation_and_troubleshooting/validating-an-installation This is an example of successful installation log output, including cluster access details and time elapsed for different stages. ```log ... time="2020-12-03T09:50:47Z" level=info msg="Install complete!" time="2020-12-03T09:50:47Z" level=info msg="To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig'" time="2020-12-03T09:50:47Z" level=info msg="Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com" time="2020-12-03T09:50:47Z" level=info msg="Login to the console with user: \"kubeadmin\", and password: \"password\"" time="2020-12-03T09:50:47Z" level=debug msg="Time elapsed per stage:" time="2020-12-03T09:50:47Z" level=debug msg=" Infrastructure: 6m45s" time="2020-12-03T09:50:47Z" level=debug msg="Bootstrap Complete: 11m30s" time="2020-12-03T09:50:47Z" level=debug msg=" Bootstrap Destroy: 1m5s" time="2020-12-03T09:50:47Z" level=debug msg=" Cluster Operators: 17m31s" time="2020-12-03T09:50:47Z" level=info msg="Time elapsed: 37m26s" ``` -------------------------------- ### Quick Start Task List Examples Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/web_console Start each task with a verb and do not specify the number of tasks. The first example is correct, while the second is incorrect. ```text Tasks to complete: Create a serverless application; Connect an event source; Force a new revision ``` ```text You will complete these 3 tasks: Creating a serverless application; Connecting an event source; Forcing a new revision ``` -------------------------------- ### Write Clear Quick Start Introduction Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/configuring-web-console Craft a clear, concise, and friendly introduction for quick starts that states the outcome and guides the user. Start with a verb and focus on user actions. ```text In this quick start, you will deploy a sample application to {product-title}. ``` ```text This quick start shows you how to deploy a sample application to {product-title}. ``` -------------------------------- ### Quick Start Task List Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/adding-user-preferences List quick start tasks starting with a verb, without specifying the number of tasks. ```text Tasks to complete: Create a serverless application; Connect an event source; Force a new revision ``` -------------------------------- ### Incorrect Quick Start Introduction Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/adding-user-preferences Avoid passive language that describes what the quick start does instead of what the user will achieve. ```text This quick start shows you how to deploy a sample application to {product-title}. ``` -------------------------------- ### Example bootupctl Status Output for x86_64 Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/updating_clusters/troubleshooting-a-cluster-update This is an example output of the `bootupctl status` command for an x86_64 architecture, showing the installed boot loader components and their update status. ```text Component EFI Installed: grub2-efi-x64-1:2.04-31.el8_4.1.x86_64,shim-x64-15-8.el8_1.x86_64 Update: At latest version ``` -------------------------------- ### Example bootupctl Status Output for aarch64 Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/updating_clusters/troubleshooting-a-cluster-update This is an example output of the `bootupctl status` command for an aarch64 architecture, showing the installed boot loader components and their update status. ```text Component EFI Installed: grub2-efi-aa64-1:2.02-99.el8_4.1.aarch64,shim-aa64-15.4-2.el8_1.aarch64 Update: At latest version ``` -------------------------------- ### Start a Virtual Machine Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/virtualization/index Use this command to start a virtual machine. Replace with the name of the VM you want to start. ```bash virtctl start ``` -------------------------------- ### Incorrect Quick Start Task List Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/adding-user-preferences Do not specify the number of tasks in the list, as this requires manual updates. ```text You will complete these 3 tasks: Creating a serverless application; Connecting an event source; Forcing a new revision ``` -------------------------------- ### Quick Start Card Description Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/adding-user-preferences Use a concise, action-oriented description for quick start cards, limited to one to two sentences. ```text Create a serverless application. ``` -------------------------------- ### Correct Location-Action Structure Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/web_console/adding-user-preferences Use the 'Location, action' structure to guide users, specifying where to go before what to do. ```text In the node.js deployment, hover over the icon. ``` -------------------------------- ### Example WMCO Installation Verification Output Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/windows_container_support_for_openshift/release-notes This is an example of the output you might see when verifying the WMCO installation using `oc get csv`. ```text NAME DISPLAY VERSION REPLACES PHASE windows-machine-config-operator.2.0.0 Windows Machine Config Operator 2.0.0 Succeeded ``` -------------------------------- ### Quick Start Introduction Example (Correct) Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials State the outcome of the quick start and give action to the user. This example shows the correct way to phrase the introduction. ```text In this quick start, you will deploy a sample application to {product-title}. ``` -------------------------------- ### View Quick Start API Documentation Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials Use `oc explain` to view the API documentation for ConsoleQuickStart resources. ```bash $ oc explain consolequickstarts ``` -------------------------------- ### Example Variables for Mirroring Install Images Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/deploying_installer-provisioned_clusters_on_bare_metal/ipi-install-troubleshooting Example values for variables used when mirroring OpenShift install images. These variables are typically set during the environment setup phase. ```shell UPSTREAM_REPO=${RELEASE_IMAGE} LOCAL_REG=: LOCAL_REPO='ocp4/openshift4' ``` -------------------------------- ### Example WMCO Installation Output Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/windows_container_support_for_openshift/enabling-windows-container-workloads This is an example of the output you might see when verifying the WMCO installation using `oc get csv`. It shows the operator's version and current phase. ```text NAME DISPLAY VERSION REPLACES PHASE windows-machine-config-operator.2.0.0 Windows Machine Config Operator 2.0.0 Succeeded ``` -------------------------------- ### Example Output of 'oc get all' Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/nodes/automatically-scaling-pods-with-the-custom-metrics-autoscaler-operator Shows an example of the output when verifying the Custom Metrics Autoscaler Operator installation using 'oc get all -n openshift-keda'. This includes pods, deployments, and replica sets. ```yaml NAME READY STATUS RESTARTS AGE pod/custom-metrics-autoscaler-operator-5fd8d9ffd8-xt4xp 1/1 Running 0 18m NAME READY UP-TO-DATE AVAILABLE AGE deployment.apps/custom-metrics-autoscaler-operator 1/1 1 1 18m NAME DESIRED CURRENT READY AGE replicaset.apps/custom-metrics-autoscaler-operator-5fd8d9ffd8 1 1 1 18m ``` -------------------------------- ### Quick Start Introduction Example (Incorrect) Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials Avoid phrasing that focuses on the quick start itself rather than the user's actions. This example shows an incorrect way to phrase the introduction. ```text This quick start shows you how to deploy a sample application to {product-title}. ``` -------------------------------- ### Example Output of Operator Installation Verification Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/logging/cluster-logging-deploying Shows a sample output from the 'oc get csv --all-namespaces' command, indicating the status and version of installed Operators. ```text NAMESPACE NAME DISPLAY VERSION REPLACES PHASE default elasticsearch-operator.v5.8.3 OpenShift Elasticsearch Operator 5.8.3 elasticsearch-operator.v5.8.2 Succeeded ``` -------------------------------- ### 3scale WebAssembly mapping_rules GET Request Example Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/service_mesh/service-mesh-3-x This example defines mapping rules for a GET request. It matches requests to the root path, paths starting with /products/, and specific product sold paths, reporting usage metrics like 'hits', 'products', and 'sales'. ```yaml apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: spec: pluginConfig: # ... mapping_rules: - method: GET pattern: / usages: - name: hits delta: 1 - method: GET pattern: /products/ usages: - name: products delta: 1 - method: ANY pattern: /products/{id}/sold usages: - name: sales delta: 1 - name: products delta: 1 # ... ``` -------------------------------- ### Example Output for CSV Verification Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/scalability_and_performance/cnf-numa-aware-scheduling This is an example of the output you might see when verifying the NUMA Resources Operator installation using 'oc get csv'. It shows the status of the operator. ```text NAME DISPLAY VERSION REPLACES PHASE numaresources-operator.v4.15.2 numaresources-operator 4.15.2 Succeeded ``` -------------------------------- ### Example: List parameters for a quick start template Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/observability/building_applications/odc-viewing-application-composition-using-topology-view This example demonstrates listing parameters for the `rails-postgresql-example` template in the `openshift` project. It shows the expected output format, including parameter names, descriptions, generators, and default values. ```bash $ oc process --parameters -n openshift rails-postgresql-example ``` ```text NAME DESCRIPTION GENERATOR VALUE SOURCE_REPOSITORY_URL The URL of the repository with your application source code https://github.com/sclorg/rails-ex.git SOURCE_REPOSITORY_REF Set this to a branch name, tag or other ref of your repository if you are not using the default branch CONTEXT_DIR Set this to the relative path to your project if it is not in the root of your repository APPLICATION_DOMAIN The exposed hostname that will route to the Rails service rails-postgresql-example.openshiftapps.com GITHUB_WEBHOOK_SECRET A secret string used to configure the GitHub webhook expression [a-zA-Z0-9]{40} SECRET_KEY_BASE Your secret key for verifying the integrity of signed cookies expression [a-z0-9]{127} APPLICATION_USER The application user that is used within the sample application to authorize access on pages openshift APPLICATION_PASSWORD The application password that is used within the sample application to authorize access on pages secret DATABASE_SERVICE_NAME Database service name postgresql POSTGRESQL_USER database username expression user[A-Z0-9]{3} POSTGRESQL_PASSWORD database password expression [a-zA-Z0-9]{8} POSTGRESQL_DATABASE database name root POSTGRESQL_MAX_CONNECTIONS database max connections 10 POSTGRESQL_SHARED_BUFFERS database shared buffers 12MB ```