Skip to content

Commit

Permalink
Remove the OpenShift release manifests and installer flag
Browse files Browse the repository at this point in the history
In the early days of the Dashboard project there were significant
differences between the Dashboard releases on Kubernetes and OpenShift,
including default provision of an `oauth-proxy` deployment, ingress, etc.

That is no longer the case since Tekton Dashboard v0.10.0 in September 2020,
the only remaining difference between the release manifests is the namespace
(`openshift-pipelines` vs. `tekton-pipelines`).
  • Loading branch information
AlanGreene authored and tekton-robot committed Jan 9, 2023
1 parent 726d33a commit d0c0f53
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 107 deletions.
63 changes: 9 additions & 54 deletions docs/dev/installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ It covers the following topics:
- [Install command](#install-command)
- [Installing on Kubernetes](#installing-on-kubernetes)
- [OpenShift with Tekton Pipelines and Triggers installed by OpenShift Pipelines Operator](#openshift-with-tekton-pipelines-and-triggers-installed-by-openshift-pipelines-operator)
- [OpenShift with Tekton Pipelines and Triggers installed manually using YAML manifests](#openshift-with-tekton-pipelines-and-triggers-installed-manually-using-yaml-manifests)
- [Read only install](#read-only-install)
- [Installing in a custom namespace](#installing-in-a-custom-namespace)
- [Read only install](#read-only-install)
- [Installing for single namespace visibility](#installing-for-single-namespace-visibility)
- [Install ingress](#install-ingress)
- [Uninstall command](#uninstall-command)
Expand Down Expand Up @@ -71,7 +70,6 @@ Accepted options:
[--logout-url <logout-url>] Will set up the logout URL
[--namespace <namespace>] Will override install namespace
[--nightly] Will download manifests from the nightly releases channel
[--openshift] Will build manifests for openshift
[--output <file>] Will output built manifests in the file instead of in the console
[--pipelines-namespace <namespace>] Override the namespace where Tekton Pipelines is installed (defaults to tekton-pipelines)
[--platform <platform>] Override the platform to build for
Expand All @@ -87,14 +85,9 @@ Accepted options:

The `install` command is used to install the Tekton Dashboard in a cluster. It supports both Kubernetes and OpenShift.

Note that OpenShift supports two install methods:
- Tekton Pipelines and Triggers installed by openshift pipelines operator
- Tekton Pipelines and Triggers installed manually using YAML manifests

Examples below illustrate the main `install` options:
- [Installing on Kubernetes](#installing-on-kubernetes)
- [OpenShift with Tekton Pipelines and Triggers installed by OpenShift Pipelines Operator](#openshift-with-tekton-pipelines-and-triggers-installed-by-openshift-pipelines-operator)
- [OpenShift with Tekton Pipelines and Triggers installed manually using YAML manifests](#openshift-with-tekton-pipelines-and-triggers-installed-manually-using-yaml-manifests)
- [Installing in a custom namespace](#installing-in-a-custom-namespace)
- [Installing for single namespace visibility](#installing-for-single-namespace-visibility)
- [Install ingress](#install-ingress)
Expand All @@ -114,35 +107,10 @@ This will install the Dashboard in the `tekton-pipelines` namespace and assumes
To install the Tekton Dashboard on OpenShift after installing Tekton Pipelines and Triggers using OpenShift Pipelines Operator, run the command:

```bash
./scripts/installer install --openshift
./scripts/installer install --namespace openshift-pipelines
```

### OpenShift with Tekton Pipelines and Triggers installed manually using YAML manifests

To install the Tekton Dashboard on OpenShift after installing Tekton Pipelines and Triggers manually using YAML manifests, you will need to override Tekton Pipelines and Triggers install namespaces.

When installing from the manifests, Tekton Pipelines and Triggeers will be deployed in the `tekton-pipelines` namespace, whereas OpenShift Pipelines Operator uses the `openshift-pipelines` namespace.

Therefore, you will need to add the `--pipelines-namespace tekton-pipelines` and `--triggers-namespace tekton-pipelines` options when calling the installer script:

```bash
./scripts/installer install --openshift --pipelines-namespace tekton-pipelines --triggers-namespace tekton-pipelines
```

### Read only install

To install the Dashboard add the `--read-only` option when calling the `installer` script:

```bash
# for kubernetes
./scripts/installer install --read-only
# for openshift / openshift pipelines operator
./scripts/installer install --openshift --read-only
# for openshift / manifests
./scripts/installer install --openshift --read-only --pipelines-namespace tekton-pipelines --triggers-namespace tekton-pipelines
```
Alternatively, take one of the official release manifests and replace any reference to the `tekton-pipelines` namespace with `openshift-pipelines` for the same result.

### Installing in a custom namespace

Expand All @@ -153,14 +121,15 @@ To tell the `installer` script the target namespace of your choice, add the `--n
```bash
CUSTOM_NAMESPACE=my-namespace
# for kubernetes
./scripts/installer install --namespace $CUSTOM_NAMESPACE
```

### Read only install

# for openshift / openshift pipelines operator
./scripts/installer install --openshift --namespace $CUSTOM_NAMESPACE
To install the Dashboard add the `--read-only` option when calling the `installer` script:

# for openshift / manifests
./scripts/installer install --openshift --pipelines-namespace tekton-pipelines --triggers-namespace tekton-pipelines --namespace $CUSTOM_NAMESPACE
```bash
./scripts/installer install --read-only
```

### Installing for single namespace visibility
Expand All @@ -172,14 +141,7 @@ To install for single namespace visibility run the following command:
```bash
TENANT_NAMESPACE=my-namespace
# for kubernetes
./scripts/installer install --tenant-namespace $TENANT_NAMESPACE
# for openshift / openshift pipelines operator
./scripts/installer install --openshift --tenant-namespace $TENANT_NAMESPACE
# for openshift / manifests
./scripts/installer install --openshift --pipelines-namespace tekton-pipelines --triggers-namespace tekton-pipelines --tenant-namespace $TENANT_NAMESPACE
```

### Install ingress
Expand All @@ -203,14 +165,7 @@ To uninstall the Dashboard, use the `uninstall` instead of the `install` command
The `installer` script can be used to build the Dashboard docker image and the YAML manifests (taking care of command line options) by using the `build` command when calling the script:

```bash
# for kubernetes
./scripts/installer build
# for openshift / openshift pipelines operator
./scripts/installer build --openshift
# for openshift / manifests
./scripts/installer build --openshift --pipelines-namespace tekton-pipelines --triggers-namespace tekton-pipelines
```

This will NOT deploy the resulting manifest in the target cluster but will build and push the Dashboard docker image to [whichever docker repo was configured](./README.md#build-and-deploy-with-kustomize-and-ko) for `ko` to work with and will display the YAML manifests in the console output.
Expand Down
19 changes: 0 additions & 19 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ This guide explains how to install Tekton Dashboard. It covers the following top
- [Before you begin](#before-you-begin)
- [Pre-requisites](#pre-requisites)
- [Installing Tekton Dashboard on Kubernetes](#installing-tekton-dashboard-on-kubernetes)
- [Installing Tekton Dashboard on OpenShift](#installing-tekton-dashboard-on-openshift)
- [Installing with the installer script](#installing-with-the-installer-script)
- [Accessing the Dashboard](#accessing-the-dashboard)
- [Uninstalling the Dashboard on Kubernetes](#uninstalling-the-dashboard-on-kubernetes)
Expand Down Expand Up @@ -67,24 +66,6 @@ To install Tekton Dashboard on a Kubernetes cluster:

Congratulations! You have successfully installed Tekton Dashboard on your Kubernetes cluster.

## Installing Tekton Dashboard on OpenShift

To install Tekton Dashboard on an OpenShift cluster:

1. Install the Openshift Pipeline Operator from the operator hub.

1. Assuming you want to install the Dashboard into the `openshift-pipelines` namespace, which is the default one:

```bash
kubectl apply --filename https://storage.googleapis.com/tekton-releases/dashboard/latest/openshift-tekton-dashboard-release.yaml --validate=false
```

Congratulations! You have successfully installed Tekton Dashboard on your OpenShift cluster.

**Note for users installing Tekton Pipelines and Triggers outside the OpenShift Pipelines operator:**

Tekton Dashboard on OpenShift works out of the box with the OpenShift Pipelines operator. If you installed Tekton Pipelines and Triggers without using the OpenShift Pipelines operator, you will need to change the following args `--pipelines-namespace=openshift-pipelines` and `--triggers-namespace=openshift-pipelines` and set their values to the namespace where Pipelines and Triggers were respectively deployed.

## Installing with the installer script

`v0.8.0` and later releases provide an installer script to simplify deploying the Tekton Dashboard with custom options.
Expand Down
11 changes: 0 additions & 11 deletions scripts/installer
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
# limitations under the License.

# dashboard flavour
OPENSHIFT="false"
READONLY="false"

# configuration default values
Expand Down Expand Up @@ -128,20 +127,14 @@ download() {
setup() {
if [ ! -z "$OVERRIDE_NAMESPACE" ]; then
INSTALL_NAMESPACE="$OVERRIDE_NAMESPACE"
elif [ "$OPENSHIFT" == "true" ]; then
INSTALL_NAMESPACE="openshift-pipelines"
fi

if [ ! -z "$OVERRIDE_PIPELINES_NAMESPACE" ]; then
PIPELINES_NAMESPACE="$OVERRIDE_PIPELINES_NAMESPACE"
elif [ "$OPENSHIFT" == "true" ]; then
PIPELINES_NAMESPACE="openshift-pipelines"
fi

if [ ! -z "$OVERRIDE_TRIGGERS_NAMESPACE" ]; then
TRIGGERS_NAMESPACE="$OVERRIDE_TRIGGERS_NAMESPACE"
elif [ "$OPENSHIFT" == "true" ]; then
TRIGGERS_NAMESPACE="openshift-pipelines"
fi
}

Expand Down Expand Up @@ -423,7 +416,6 @@ help () {
echo -e "\t[--logout-url <logout-url>]\t\tWill set up the logout URL"
echo -e "\t[--namespace <namespace>]\t\tWill override install namespace"
echo -e "\t[--nightly]\t\t\t\tWill download manifests from the nightly releases channel"
echo -e "\t[--openshift]\t\t\t\tWill build manifests for openshift"
echo -e "\t[--output <file>]\t\t\tWill output built manifests in the file instead of in the console"
echo -e "\t[--pipelines-namespace <namespace>]\tOverride the namespace where Tekton Pipelines is installed (defaults to tekton-pipelines)"
echo -e "\t[--platform <platform>]\t\t\tOverride the platform to build for"
Expand Down Expand Up @@ -490,9 +482,6 @@ while [[ $# -gt 0 ]]; do
'--nightly')
BASE_RELEASE_URL="https://storage.googleapis.com/tekton-releases-nightly/dashboard"
;;
'--openshift')
OPENSHIFT="true"
;;
'--read-only')
READONLY="true"
;;
Expand Down
2 changes: 0 additions & 2 deletions tekton/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,6 @@ spec:
# build pre configured manifests
./scripts/installer release --debug --platform $(params.platforms) --tag $(params.versionTag) --output $OUTPUT_RELEASE_DIR/tekton-dashboard-release.yaml
./scripts/installer release --debug --read-only --platform $(params.platforms) --tag $(params.versionTag) --output $OUTPUT_RELEASE_DIR/tekton-dashboard-release-readonly.yaml
./scripts/installer release --debug --openshift --platform $(params.platforms) --tag $(params.versionTag) --output $OUTPUT_RELEASE_DIR/openshift-tekton-dashboard-release.yaml
./scripts/installer release --debug --openshift --read-only --platform $(params.platforms) --tag $(params.versionTag) --output $OUTPUT_RELEASE_DIR/openshift-tekton-dashboard-release-readonly.yaml
- name: koparse
image: gcr.io/tekton-releases/dogfooding/koparse:latest
Expand Down
4 changes: 1 addition & 3 deletions tekton/release-cheat-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,6 @@ the dashboard repo, a terminal window and a text editor.
commit-sha 6ea31d92a97420d4b7af94745c45b02447ceaa19
tekton-dashboard-release https://storage.googleapis.com/tekton-releases/dashboard/previous/v0.19.0/tekton-dashboard-release.yaml
tekton-dashboard-release-readonly https://storage.googleapis.com/tekton-releases/dashboard/previous/v0.19.0/tekton-dashboard-release-readonly.yaml
tekton-dashboard-openshift-release https://storage.googleapis.com/tekton-releases/dashboard/previous/v0.19.0/openshift-tekton-dashboard-release.yaml
tekton-dashboard-openshift-release-readonly https://storage.googleapis.com/tekton-releases/dashboard/previous/v0.19.0/openshift-tekton-dashboard-release-readonly.yaml
(...)
```
Expand All @@ -91,7 +89,7 @@ Creating the release announcement is currently a manual process but will be auto
1. Add any upgrade and deprecation notices as required.
1. Attach the release manifests to the release: `tekton-dashboard-*.yaml` and `openshift-tekton-dashboard-*.yaml`.
1. Attach the release manifests to the release: `tekton-dashboard-*.yaml`.
1. Once the release notes are ready, un-check the "This is a pre-release" checkbox since you're making a legit for-reals release!
Expand Down
14 changes: 0 additions & 14 deletions tekton/release-pipeline.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,6 @@ spec:
- name: release-file-readonly
description: the URL of the release file
value: $(tasks.report-bucket.results.release-readonly)
- name: release-file-openshift
description: the URL of the release file
value: $(tasks.report-bucket.results.release-openshift)
- name: release-file-openshift-readonly
description: the URL of the release file
value: $(tasks.report-bucket.results.release-openshift-readonly)
tasks:
- name: git-clone
taskRef:
Expand Down Expand Up @@ -170,12 +164,6 @@ spec:
- name: release-readonly
description: The full URL of the release file (read-only) in the bucket
type: string
- name: release-openshift
description: The full URL of the release file (OpenShift) in the bucket
type: string
- name: release-openshift-readonly
description: The full URL of the release file (OpenShift read-only) in the bucket
type: string
steps:
- name: create-results
image: alpine
Expand All @@ -185,5 +173,3 @@ spec:
BASE_URL=$(echo ${BASE_URL} | sed 's,gs://,https://storage.googleapis.com/,g')
echo "${BASE_URL}/tekton-dashboard-release.yaml" > $(results.release.path)
echo "${BASE_URL}/tekton-dashboard-release-readonly.yaml" > $(results.release-readonly.path)
echo "${BASE_URL}/openshift-tekton-dashboard-release.yaml" > $(results.release-openshift.path)
echo "${BASE_URL}/openshift-tekton-dashboard-release-readonly.yaml" > $(results.release-openshift-readonly.path)
4 changes: 0 additions & 4 deletions test/e2e-tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -206,10 +206,6 @@ if [ -z "$SKIP_BUILD_TEST" ]; then
$tekton_repo_dir/scripts/installer release || fail_test "Failed to build manifests for k8s"
echo "Building manifests for k8s --read-only"
$tekton_repo_dir/scripts/installer release --read-only || fail_test "Failed to build manifests for k8s --read-only"
echo "Building manifests for openshift"
$tekton_repo_dir/scripts/installer release --openshift || fail_test "Failed to build manifests for openshift"
echo "Building manifests for openshift --read-only"
$tekton_repo_dir/scripts/installer release --openshift --read-only || fail_test "Failed to build manifests for openshift --read-only"
fi

header "Building browser E2E image"
Expand Down

0 comments on commit d0c0f53

Please sign in to comment.