quickstart CRD

openshift · Nov 4, 2020 · f7a1c66 · f7a1c66
1 parent ea90110
commit f7a1c66
Show file tree

Hide file tree

Showing 25 changed files with 842 additions and 65 deletions.
diff --git a/...nd/packages/console-app/src/components/quick-starts/catalog/QuickStartTileDescription.tsx b/...nd/packages/console-app/src/components/quick-starts/catalog/QuickStartTileDescription.tsx
@@ -6,7 +6,7 @@ import './QuickStartTileDescription.scss';
 
 type QuickStartTileDescriptionProps = {
   description: string;
-  prerequisites?: string;
+  prerequisites?: string[];
   unmetPrerequisite?: boolean;
 };
 const QuickStartTileDescription: React.FC<QuickStartTileDescriptionProps> = ({
@@ -23,7 +23,9 @@ const QuickStartTileDescription: React.FC<QuickStartTileDescriptionProps> = ({
         {prerequisites && (
           <>
             <Text component={TextVariants.h5}>{t('quickstart~Prerequisites')}</Text>
-            <Text component={TextVariants.small}>{prerequisites}</Text>
+            {prerequisites.map((prerequisite) => (
+              <Text component={TextVariants.small}>{prerequisite}</Text>
+            ))}
           </>
         )}
       </div>

diff --git a/frontend/packages/console-app/src/components/quick-starts/controller/QuickStartContent.tsx b/frontend/packages/console-app/src/components/quick-starts/controller/QuickStartContent.tsx
@@ -51,7 +51,7 @@ const QuickStartContent: React.FC<QuickStartContentProps> = ({
           tasks={tasks}
           conclusion={conclusion}
           allTaskStatuses={allTaskStatuses}
-          nextQuickStart={nextQuickStart}
+          nextQuickStart={nextQuickStart[0]}
           onQuickStartChange={onQuickStartChange}
           onTaskSelect={onTaskSelect}
         />

diff --git a/...tend/packages/console-app/src/components/quick-starts/controller/QuickStartTaskReview.tsx b/...tend/packages/console-app/src/components/quick-starts/controller/QuickStartTaskReview.tsx
@@ -29,7 +29,7 @@ const QuickStartTaskReview: React.FC<QuickStartTaskReviewProps> = ({
   taskStatus,
   onTaskReview,
 }) => {
-  const { instructions, taskHelp } = review;
+  const { instructions, failedTaskHelp: taskHelp } = review;
   const { t } = useTranslation();
 
   const alertClassNames = cx('co-quick-start-task-review', {

diff --git a/...onsole-app/src/components/quick-starts/controller/__tests__/QuickStartTaskReview.spec.tsx b/...onsole-app/src/components/quick-starts/controller/__tests__/QuickStartTaskReview.spec.tsx
@@ -47,6 +47,6 @@ describe('QuickStartTaskReview', () => {
         .find(SyncMarkdownView)
         .at(1)
         .props().content,
-    ).toEqual(props.review.taskHelp);
+    ).toEqual(props.review.failedTaskHelp);
   });
 });
diff --git a/...d/packages/console-app/src/components/quick-starts/data/mocks/install_quickstart_yamls.sh b/...d/packages/console-app/src/components/quick-starts/data/mocks/install_quickstart_yamls.sh
@@ -0,0 +1,32 @@
+echo -e "\e[1m \e[100m \e[94m ======================================== \e[97m \e[49m"
+echo -e "\e[100m \e[94m   WELCOME TO QUICK MOCK INSTALLER  \e[97m \e[49m"
+echo -e "\e[100m \e[94m   Don't forget to OC LOGIN to the cluster before running this script  \e[97m \e[49m"
+echo -e "\e[100m \e[94m==   -  STEP 1/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - installing/reinstalling CRD - \e[97m"
+oc delete -f yamls/quick-start-crd.yaml 
+oc apply -f yamls/quick-start-crd.yaml 
+sleep 5
+echo -e "\e[100m \e[94m==   -  STEP 2/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - Installing explore pipeline QS - \e[97m"
+oc apply -f yamls/explore-pipeline-quickstart.yaml
+echo -e "\e[100m \e[94m==   -  STEP 3/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - Installing explore serverless QS - \e[97m"
+oc apply -f yamls/explore-serverless-quickstart.yaml
+echo -e "\e[100m \e[94m==   -  STEP 4/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - Installing serverless app QS - \e[97m"
+oc apply -f yamls/serverless-application-quickstart.yaml
+echo -e "\e[100m \e[94m==   -  STEP 5/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - Installing pipeline app QS - \e[97m"
+oc apply -f yamls/install-associate-pipeline-quickstart.yaml
+echo -e "\e[100m \e[94m==   -  STEP 6/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - Installing sample app QS - \e[97m"
+oc apply -f yamls/sample-application-quickstart.yaml
+echo -e "\e[100m \e[94m==   -  STEP 7/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - Installing Healthcheck app QS - \e[97m"
+oc apply -f yamls/add-healthchecks-quickstart.yaml
+echo -e "\e[100m \e[94m==   -  STEP 8/8 -   == \e[97m \e[49m"
+echo -e "\e[32m  - Installing Monitoring QS - \e[97m"
+oc apply -f yamls/monitor-sampleapp-quickstart.yaml
+echo -e "\e[100m \e[94m   DONE !! ENJOY YOUR DAY !! DEV CONSOLE UI  \e[97m \e[49m"
+echo -e "\e[100m \e[94m ======================================== \e[97m \e[49m \e[0m"
+sleep 3
diff --git a/...tarts/data/add-healthchecks-quickstart.ts → ...mocks/json/add-healthchecks-quickstart.ts b/...tarts/data/add-healthchecks-quickstart.ts → ...mocks/json/add-healthchecks-quickstart.ts
@@ -1,4 +1,6 @@
-export const addHealthChecksQuickStart = {
+import { QuickStart } from '../../../utils/quick-start-types';
+
+export const addHealthChecksQuickStart: QuickStart = {
   apiVersion: 'console.openshift.io/v1',
   kind: 'QuickStarts',
   metadata: {
@@ -10,7 +12,7 @@ export const addHealthChecksQuickStart = {
     duration: 10,
     iconURL: '',
     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.`,
+    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: [
@@ -25,7 +27,7 @@ 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**?`,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You have viewed the details of your sample app!`,
@@ -39,7 +41,7 @@ Is the side panel titled **nodejs-sample**?`,
         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?`,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You have verified that there are no existing health checks!`,
@@ -59,7 +61,7 @@ You will be brought back to the Topology View.`,
         review: {
           instructions: `#### Verify that health checks are now configured:
 Is the inline notification gone?`,
-          taskHelp: `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.`,
+          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.`,
         },
         recapitulation: {
           success: `You have added health checks to your sample app!`,
@@ -69,6 +71,6 @@ Is the inline notification gone?`,
     ],
     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`,
+    nextQuickStart: [`monitor-sampleapp`],
   },
 };
diff --git a/...tarts/data/explore-pipeline-quickstart.ts → ...mocks/json/explore-pipeline-quickstart.ts b/...tarts/data/explore-pipeline-quickstart.ts → ...mocks/json/explore-pipeline-quickstart.ts
@@ -1,5 +1,5 @@
 import { FLAG_OPENSHIFT_PIPELINE } from '@console/dev-console/src/const';
-import { QuickStart } from '../utils/quick-start-types';
+import { QuickStart } from '../../../utils/quick-start-types';
 import { pipelineIcon } from './tour-icons';
 
 export const explorePipelinesQuickStart: QuickStart = {
@@ -14,7 +14,7 @@ export const explorePipelinesQuickStart: QuickStart = {
     duration: 10,
     iconURL: pipelineIcon,
     description: `Install the OpenShift® Pipelines Operator to build Pipelines using Tekton.`,
-    prerequisites: '',
+    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.
@@ -41,7 +41,7 @@ To start using Pipelines, install the OpenShift® Pipelines Operator on your clu
 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**?`,
-          taskHelp: `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.`,
+          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.`,
         },
         recapitulation: {
           success: `You have installed the Pipelines Operator!`,
@@ -50,7 +50,7 @@ In the status column, is the status of the OpenShift Pipelines Operator **Succee
       },
     ],
     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`,
+    nextQuickStart: [`install-app-and-associate-pipeline`],
     accessReviewResources: [
       {
         group: 'operators.coreos.com',

diff --git a/...rts/data/explore-serverless-quickstart.ts → ...cks/json/explore-serverless-quickstart.ts b/...rts/data/explore-serverless-quickstart.ts → ...cks/json/explore-serverless-quickstart.ts
@@ -1,5 +1,5 @@
 import { FLAG_KNATIVE_SERVING } from '@console/knative-plugin';
-import { QuickStart } from '../utils/quick-start-types';
+import { QuickStart } from '../../../utils/quick-start-types';
 import { serverlessIcon } from './tour-icons';
 
 export const exploreServerlessQuickStart: QuickStart = {
@@ -14,7 +14,7 @@ export const exploreServerlessQuickStart: QuickStart = {
     duration: 10,
     iconURL: serverlessIcon,
     description: `Install the OpenShift Serverless Operator to deploy stateless, event-trigger-based applications.`,
-    prerequisites: '',
+    prerequisites: [''],
     introduction: `Red Hat® OpenShift® Serverless lets you run stateless, serverless workloads on a single multi-cloud container platform.
 
 Serverless reduces the need to manage infrastructure or perform back-end development. Scaling is automated, and applications can run on any cloud, hybrid, or on-premises environment. Choosing Serverless means simplicity, portability, and efficiency.
@@ -37,7 +37,7 @@ Adding OpenShift Serverless to your OpenShift Container Platform cluster is quic
           instructions: `#### To verify that the OpenShift Serverless Operator is installed:
 
 In the Status column of the **Installed Operators** page, is the OpenShift Serverless Operator’s status **Succeeded?**`,
-          taskHelp: `This task is incomplete. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/serverless/installing_serverless/installing-openshift-serverless.html) about this topic.`,
+          failedTaskHelp: `This task is incomplete. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/serverless/installing_serverless/installing-openshift-serverless.html) about this topic.`,
         },
 
         recapitulation: {
@@ -65,7 +65,7 @@ Go to the **All Instances** tab of the OpenShift Serverless Operator.
 
 Are the Knative Serving and Knative Eventing resources in the list of instances?
 `,
-          taskHelp: `This task isn’t verified yet. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/serverless/installing_serverless/installing-knative-serving.html#serverless-create-serving-project-web-console_installing-knative-serving) about this topic.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/serverless/installing_serverless/installing-knative-serving.html#serverless-create-serving-project-web-console_installing-knative-serving) about this topic.`,
         },
         recapitulation: {
           success: `You just created instances of the Knative Service and Knative Eventing resources.`,
@@ -74,7 +74,7 @@ Are the Knative Serving and Knative Eventing resources in the list of instances?
       },
     ],
     conclusion: `Your Serverless Operator is ready! If you want to learn how to deploy a serverless application, take the **Creating a Serverless application** quick start.`,
-    nextQuickStart: `serverless-application`,
+    nextQuickStart: [`serverless-application`],
     accessReviewResources: [
       {
         group: 'operators.coreos.com',

diff --git a/.../install-associate-pipeline-quickstart.ts → .../install-associate-pipeline-quickstart.ts b/.../install-associate-pipeline-quickstart.ts → .../install-associate-pipeline-quickstart.ts
@@ -1,5 +1,5 @@
 import { FLAG_OPENSHIFT_PIPELINE } from '@console/dev-console/src/const';
-import { QuickStart } from '../utils/quick-start-types';
+import { QuickStart } from '../../../utils/quick-start-types';
 import { pipelineIcon } from './tour-icons';
 
 export const installAssociatePipelineQuickStart: QuickStart = {
@@ -14,7 +14,7 @@ export const installAssociatePipelineQuickStart: QuickStart = {
     duration: 10,
     iconURL: pipelineIcon,
     description: `Import an application from Git, add a pipeline to it, and run the Pipeline.`,
-    prerequisites: '',
+    prerequisites: [''],
     introduction: `This quick start guides you through creating an application and associating it with a CI/CD pipeline.
 `,
     tasks: [
@@ -32,7 +32,7 @@ export const installAssociatePipelineQuickStart: QuickStart = {
 Momentarily, you should be brought to the **Topology** view.
 
 Is there an Application and Deployment name \`django-ex?\``,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You just installed a deployment with an associated pipeline! Next, we'll explore your application in topology.`,
@@ -50,7 +50,7 @@ Is there an Application and Deployment name \`django-ex?\``,
 2. The **Pipeline Runs** section displays the associated pipeline.
 
 Is there a Pipeline named django-ex-git?`,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You just located the associated Pipeline! Next, we'll start and explore your Pipeline.`,
@@ -72,7 +72,7 @@ Notice the Pipeline Runs section of the Side Panel
 4. When the pipeline run is complete, you will see a **Succeeded** badge on the page title.
 
 Is the status Succeeded?`,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You have run your pipeline successfully`,
@@ -81,7 +81,7 @@ Is the status Succeeded?`,
       },
     ],
     conclusion: `You just created an application and associated a pipeline with it, and successfully started the pipeline.`,
-    nextQuickStart: ``,
+    nextQuickStart: [``],
     flags: {
       required: [FLAG_OPENSHIFT_PIPELINE],
     },

diff --git a/...arts/data/monitor-sampleapp-quickstart.ts → ...ocks/json/monitor-sampleapp-quickstart.ts b/...arts/data/monitor-sampleapp-quickstart.ts → ...ocks/json/monitor-sampleapp-quickstart.ts
@@ -1,4 +1,6 @@
-export const monitorSampleAppQuickStart = {
+import { QuickStart } from '../../../utils/quick-start-types';
+
+export const monitorSampleAppQuickStart: QuickStart = {
   apiVersion: 'console.openshift.io/v1',
   kind: 'QuickStarts',
   metadata: {
@@ -10,7 +12,7 @@ export const monitorSampleAppQuickStart = {
     duration: 10,
     iconURL: '',
     description: `Now that you’ve created a sample application and added health checks, let’s monitor your application.`,
-    prerequisites: `You completed the "Getting started with a sample" quick start.`,
+    prerequisites: [`You completed the "Getting started with a sample" quick start.`],
     introduction: `### This quick start shows you how to monitor your sample application.
 You should have previously created the **sample-app** application and **nodejs-sample** deployment via the **Get started with a sample** quick start. If you haven't, you may be able to follow these tasks with any existing deployment.`,
     tasks: [
@@ -28,7 +30,7 @@ You can see context sensitive metrics and alerts in the **Monitoring** tab.`,
 1. Do you see a **Metrics** accordion in the side panel?
 2. Do you see a **View monitoring dashboard** link in the **Metrics** accordion?
 3. Do you see three charts in the **Metrics** accordion: **CPU Usage**, **Memory Usage** and **Receive Bandwidth**?`,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You have learned how you can monitor your sample app!`,
@@ -44,7 +46,7 @@ You can see context sensitive metrics and alerts in the **Monitoring** tab.`,
         review: {
           instructions: `#### To verify that you are able to view the monitoring dashboard:
 Do you see metrics charts in the dashboard?`,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You have learned how to view the dashboard in the context of your sample app!`,
@@ -61,7 +63,7 @@ Do you see metrics charts in the dashboard?`,
           instructions: `#### Verify you can see the chart associated with the query:
 Do you see a chart displayed with filesystem usage for your project?  Note: select **Custom Query** from the dropdown to create and run a custom query utilizing PromQL.
 `,
-          taskHelp: `This task isn’t verified yet. Try the task again.`,
+          failedTaskHelp: `This task isn’t verified yet. Try the task again.`,
         },
         recapitulation: {
           success: `You have learned how to run a query!`,
@@ -71,6 +73,6 @@ Do you see a chart displayed with filesystem usage for your project?  Note: sele
     ],
     conclusion: `You have learned how to access workload monitoring and metrics!`,
 
-    nextQuickStart: ``,
+    nextQuickStart: [``],
   },
 };