CH2 ConsoleQuickStarts

2.1 ConsoleQuickStart Basic Usage

The ConsoleQuickStart custom resource provides a convienient way to offer guided experiences and usage documentation within the OpenShift Console.

  1. From the Overview page, Choose the "View all quick starts" link within the "Getting started resources" section

    Overview page
    View All Quickstarts

  2. Search quickstarts for "Helm", then select the tile labeled "Manage available content in the Helm Chart Catalog"

    Search Helm Quickstarts

  3. Follow along with the quickstart instructions to install the azure charts cluster-wide

    Start a Quickstart
    Run a Quickstart
    Quickstart content - Search for Helm
    Quickstart content - Create Helm Chart
    Quickstart content - Install Helm Chart

  4. After completing each instruction in the quickstart guide, click "Next". Then, follow the "Check your work" section to validate your work

    Quickstart - Check your work

  5. Select a project from the list, or create a new one.

  6. Follow the prompts to check your work and confirm that Azure helm charts are available in the "+Add" Menu.

    Quickstart content
    Quickstart content

  7. Click "Next" when you are satisified with the results. Then click Close to complete the QuickStart

2.2 Disabling Defaults QuickStarts

Image a situation where we wanted our team to have access to the Bitnami Helm repos, but we don’t want to clutter up the menu for other developers by making this content available cluster-wide. ProjectHelmChart resources are the perfect solution when you need per-project or per-team usage of Helm repositories on a cluster.

In this section, we will learn how to modify an existing ConsoleQuickStart resource with new instructions. The resulting ConsoleQuickStart resource should install the Bitnami Helm repo (instead of the Azure helm repository).

  1. Use an admin account to create a new project namespace for this test:

    oc new-project summit-connect

  2. Search for Resource type ConsoleQuickStarts

  3. Select the item named install-helmchartrepo-ns

  4. Generate a patch file that will hide quickstarts from our 'disabled' list:

    cat <<EOF > /tmp/patch.yaml
spec:
  customization:
    quickStarts:
      disabled:
        - install-helmchartrepo-ns
EOF

  5. Send the configuration patch to the console cluster operator:

    oc patch consoles.operator.openshift.io cluster --type merge --patch-file /tmp/patch.yaml

2.3 QuickStart Modifications

  1. Download a copy of the install-helmchartrepo-ns quickstart:

    oc get ConsoleQuickStart/install-helmchartrepo-ns -o yaml > helm-qs.yaml

  2. Update the quickstart’s included url attribute with the Bitnami helm repo address: https://charts.bitnami.com/bitnami

    sed -i helm-qs.yaml -e "s/url: 'https:\/\/raw.githubusercontent.com\/Azure-Samples\/helm-charts\/master\/docs'/url: 'https:\/\/charts.bitnami.com\/bitnami\/'/"

  3. Update the quickstart’s name / id attribute with a unique value:

    sed -i helm-qs.yaml -e "s/name: install-helmchartrepo-ns/name: install-helmchart-bitnami/"

  4. Upload the updated quickstart:

    oc create -f helm-qs.yaml

In the next section, the reader will verify that the quickstart has been updated by running a manual test of the modified resource.

2.4 Check your work - Helm Charts per project

Follow along with the "Add Helm Chart Repositories to extend the Developer Catalog for your project" quickstart to test your modifications from the previous seciton:

  1. Click on the "?" icon in the header menu, Then select "Quick Starts".

  2. Search for "Helm", then select the tile labeled "Add Helm Chart Repositories to extend the Developer Catalog for your project"

  3. Complete each step of the quickstart. Upon completion, you will confirm that the Bitnami helm repo has been enabled for use within the summit-connect project namespace