From 1193372fc1e611a9be3b87cdff5aba4994856c3e Mon Sep 17 00:00:00 2001 From: chadmf Date: Wed, 20 Oct 2021 11:11:22 -0500 Subject: [PATCH] added details on how to generate kubeconfig --- 4.9/beta/ci-pipeline-beta.md | 63 ++++++++++++++++++++++-------------- 1 file changed, 39 insertions(+), 24 deletions(-) diff --git a/4.9/beta/ci-pipeline-beta.md b/4.9/beta/ci-pipeline-beta.md index 61151dc..ed17bd5 100644 --- a/4.9/beta/ci-pipeline-beta.md +++ b/4.9/beta/ci-pipeline-beta.md @@ -1,36 +1,44 @@ # Operator Certification CI Pipeline
Beta Instructions ## Table of Contents -* [Before you start](#before-you-start) - * [What you will need](#what-you-need) - * [Preparing your Operator Bundle](#prepare-bundle) -* [Installation](#installation) - * [Step 1 - Install OpenShift Pipelines Operator](#step1) - * [Step 2 - Configure the OpenShift CLI tool](#step2) - * [Step 3 - Create an OpenShift Project (namespace) to work in](#step3) - * [Step 4 - Add the Kubeconfig secret](#step4) - * [Step 5 - Import Red Hat Catalogs](#step5) - * [Step 6 - Install the Certification Pipeline and dependencies into the cluster](#step6) - * [Step 7 - Configuration Steps for Submitting Results](#step7) -* [Optional configuration](#optional-config) - * [Optional Step - If using digest pinning (required for submission)](#digest-pinning-config) - * [Optional Step - If using a private container registry](#private-registry) -* [Pipeline Execution (Development/Iteration)](#execute-pipeline) - * [Minimal Pipeline Run](#minimal-pipeline-run) - * [Pipeline Run with Image Digest Pinning](#img-digest-pipeline-run) - * [Pipeline Run with a Private Container Registry](#private-registry-pipeline-run) -* [Submit Results to Red Hat](#submit-result) - * [Submit results from Minimal Pipeline Run](#submit-result-minimal) - * [Submit results with Image Digest Pinning](#submit-result-img-digest) - * [Submit results with a private container registry](#submit-result-private-registy) - * [Submit results with Image Digest Pinning and a private container registry](#submit-result-registy-and-pinning) +- [Operator Certification CI Pipeline
Beta Instructions](#operator-certification-ci-pipelinebeta-instructions) + - [Table of Contents](#table-of-contents) + - [Before you start:](#before-you-start) + - [What you'll need before you start:](#what-youll-need-before-you-start) + - [Prepare your Operator Bundle before you start](#prepare-your-operator-bundle-before-you-start) + - [Bundle structure](#bundle-structure) + - [Fork the upstream repo](#fork-the-upstream-repo) + - [Installation](#installation) + - [Step 1 - Install OpenShift Pipelines Operator](#step-1---install-openshift-pipelines-operator) + - [Step 2 - Configure the OpenShift CLI tool (oc)](#step-2---configure-the-openshift-cli-tool-oc) + - [Step 3 - Create an OpenShift Project (namespace) to work in](#step-3---create-an-openshift-project-namespace-to-work-in) + - [Step 4 - Add the Kubeconfig secret](#step-4---add-the-kubeconfig-secret) + - [Step 5 - Import Red Hat Catalogs](#step-5---import-red-hat-catalogs) + - [Step 6 - Install the Certification Pipeline and dependencies into the cluster](#step-6---install-the-certification-pipeline-and-dependencies-into-the-cluster) + - [Step 7 - Configuration Steps for Submitting Results](#step-7---configuration-steps-for-submitting-results) + - [Add a GitHub API Token for the repo where the PR will be created](#add-a-github-api-token-for-the-repo-where-the-pr-will-be-created) + - [Add Red Hat Container API access key](#add-red-hat-container-api-access-key) +- [Optional Configuration](#optional-configuration) + - [Optional Step - If using digest pinning (required when submitting to Red Hat)](#optional-step---if-using-digest-pinning-required-when-submitting-to-red-hat) + - [Add private key to access GitHub repo with Operator Bundle source](#add-private-key-to-access-github-repo-with-operator-bundle-source) + - [Optional Step - If using a private container registry](#optional-step---if-using-a-private-container-registry) + - [Add credentials for the Container Registry](#add-credentials-for-the-container-registry) +- [Execute the Pipeline (Development Iterations)](#execute-the-pipeline-development-iterations) + - [Minimal Pipeline Run](#minimal-pipeline-run) + - [Pipeline Run with Image Digest Pinning](#pipeline-run-with-image-digest-pinning) + - [Pipeline Run with a Private Container Registry](#pipeline-run-with-a-private-container-registry) +- [Submit Results to Red Hat](#submit-results-to-red-hat) + - [Submit results from Minimal Pipeline Run](#submit-results-from-minimal-pipeline-run) + - [Submit results with Image Digest Pinning](#submit-results-with-image-digest-pinning) + - [Submit results with a private container registry](#submit-results-with-a-private-container-registry) + - [Submit results with Image Digest Pinning and a private container registry](#submit-results-with-image-digest-pinning-and-a-private-container-registry) ## Before you start: ### What you'll need before you start: 1. An OpenShift Cluster *(recommended version 4.8 or above)* -2. Kubeconfig file for a user with cluster admin privileges +2. Kubeconfig file for a user with cluster admin privileges (usually located at ~/.kube/config If this does not exist login to OpenShift via oc login and it will be created) 3. The contents of your Operator Bundle 4. [Install](https://docs.openshift.com/container-platform/4.8/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli) `oc`, the OpenShift CLI tool (tested with version 4.7.13) 5. [Install](https://tekton.dev/docs/cli/) `tkn`, the Tekton CLI tool (tested with version 0.19.1) @@ -98,6 +106,13 @@ Once you have the contents of your Operator bundle structured properly, ```bash export KUBECONFIG=/path/to/your/cluster/kubeconfig ``` + +Example: + +```shell +export KUBECONFIG=~/.kube/config +``` + > *This kubeconfig will be used to deploy the Operator under test and run the certification checks.* ### Step 3 - Create an OpenShift Project (namespace) to work in