Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update deployment doc for disconnected cluster #272

Merged
merged 1 commit into from
Jul 5, 2021
Merged

Update deployment doc for disconnected cluster #272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion docs/DEPLOYMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
- [Add resources in DB](#add-resources-in-db)
- [Setup Catalog Refresh CronJob](#setup-catalog-refresh-cronjob)
- [Adding New Users in Config](#adding-new-users-in-config)
- [Deploying on Disconnected Cluster](#deploying-on-disconnected)
- [Troubleshooting](#troubleshooting)

## Prerequisites
Expand Down Expand Up @@ -428,6 +429,34 @@ curl -X POST -H "Authorization: <access-token>" \
```
Replace `<access-token>` with your JWT token. you must have `config-refresh` scope to call this API.

## Deploying on Disconnected Cluster

- To deploy on a disconnected cluster you need to fork the [tektoncd/catalog][catalog] or you can use your own catalog but it must follow the [Catalog TEP][catalog-tep].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess without forking also we can use tektoncd/catalog in hub right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we? disconnected cluster. they need to have a catalog in their env? right?

- Fork the tektoncd/hub and update the [hub config][hub-config] file for your catalog details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please add/explain more or add an example of block of what needs to be updated in the config file ?

- Update the catalog details with your catalog
```
catalogs:
- name: tekton
org: tektoncd
type: community
url: https://github.com/tektoncd/catalog
revision: main
```
You can find the template at bottom of [hub config][hub-config] file.
- Mirror the Hub Deployment Images to the registry disconnected cluster has access to.
You can use release images or build your own. For hub release images, you can use latest release tag as image tag. for eg. `quay.io/tekton-hub/ui:v1.3.0`. You can check the latest release [here][hub-releases].
- List of images to be mirrored
- UI - `quay.io/tekton-hub/ui`
- API - `quay.io/tekton-hub/api`
- DB-Migration - `quay.io/tekton-hub/db-migration`
- DB - `postgres:13@sha256:260a98d976574b439712c35914fdcb840755233f79f3e27ea632543f78b7a21e`

You can mirror the images using `oc` as below
```
oc image mirror quay.io/tekton-hub/ui:v1.3.0 your.registry/project/ui:v1.3.0
```
- Now, follow the steps from [Deploy Database Section](#deploy-database) above. Make sure you update the images in deployment files before applying.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please mention, how the URLs will look like after mirroring for images


## Troubleshooting

#### UI is not showing resources but catalog refresh is successful
Expand All @@ -443,7 +472,6 @@ Replace `<access-token>` with your JWT token. you must have `config-refresh` sco




[ko]: https://github.com/google/ko
[kubectl]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
[kind]: https://kind.sigs.k8s.io/docs/user/quick-start/
Expand All @@ -453,3 +481,6 @@ Replace `<access-token>` with your JWT token. you must have `config-refresh` sco
[podman]: https://podman.io/getting-started/installation
[config-yaml]: https://raw.githubusercontent.com/tektoncd/hub/master/config.yaml
[oauth-steps]:https://docs.github.com/en/developers/apps/creating-an-oauth-app
[catalog]:https://github.com/tektoncd/catalog
[catalog-tep]:https://github.com/tektoncd/community/blob/main/teps/0003-tekton-catalog-organization.md
[hub-config]:https://github.com/tektoncd/hub/blob/main/config.yaml