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.

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

Add doc and blog post about using in-cluster Devfile registries #6689

Conversation

rm3l
Copy link
Member

@rm3l rm3l commented Mar 27, 2023

What type of PR is this:
/area documentation

What does this PR do / why we need it:

Which issue(s) this PR fixes:
Fixes #6646

PR acceptance criteria:

  • Unit test

  • Integration test

  • Documentation

How to test changes / Special notes to the reviewer:

@netlify
Copy link

netlify bot commented Mar 27, 2023

Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit 6d099ce
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/64243f6fdc53680008529cfd
😎 Deploy Preview https://deploy-preview-6689--odo-docusaurus-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@openshift-ci openshift-ci bot added the area/documentation Issues or PRs related to documentation or the 'odo.dev' website label Mar 27, 2023
@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

NoCluster Tests on commit ef495ca finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

OpenShift Unauthenticated Tests on commit ef495ca finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

Unit Tests on commit ef495ca finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

Validate Tests on commit ef495ca finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

Kubernetes Tests on commit ef495ca finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

Kubernetes Docs Tests on commit dfb36dd finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

Windows Tests (OCP) on commit ef495ca finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 27, 2023

OpenShift Tests on commit ef495ca finished successfully.
View logs: TXT HTML

@rm3l rm3l force-pushed the 6646-blog-post-devfile-registry-operator-using-in-cluster-registries-with-odo branch from 37a4a41 to 7fa2d16 Compare March 27, 2023 11:34
@rm3l rm3l force-pushed the 6646-blog-post-devfile-registry-operator-using-in-cluster-registries-with-odo branch from 7fa2d16 to 09e59cc Compare March 27, 2023 11:36
- `ClusterDevfileRegistriesList`: installable at the cluster level
- `DevfileRegistriesList`: installable at the namespace level

More details on the [Devfile Registry Operator documentation](https://github.com/devfile/registry-operator/blob/main/REGISTRIES_LISTS.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

You could add a note that such registries are not necessarily running into the cluster.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 2fe2050 (#6689)


On Kubernetes, the Helm Chart installed above will create an Ingress reachable via a DNS domain named as follows: `devfile-registry-<namespace>.<ingressDomain>`.

You can get the actual Host by getting the Ingress Resource, via the following command: `kubectl get ingress <registryName>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit:
I would add the command in a code block so that it can be copied and is consistent with other code blocks. Same comment for oc get route

Suggested change
You can get the actual Host by getting the Ingress Resource, via the following command: `kubectl get ingress <registryName>`.
You can get the actual Host by getting the Ingress Resource, via the following command:
```sh
kubectl get ingress <registryName>

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 9257b82 (#6689)

DefaultDevfileRegistry https://registry.devfile.io Yes

```
</details>
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps you can add a link to the blog at the end?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in ff4689e (#6689)

devfile-registry-default.172.20.0.2.nip.io
```

In this example, the Devfile Registry is now reachable at http://devfile-registry-default.172.20.0.2.nip.io
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think it would be helpful to add a note that it may take 1 or 2 minutes before the address is accessible?

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed - that could be helpful. Added in 9257b82 (#6689)

@rm3l rm3l requested review from feloy and valaparthvi March 29, 2023 07:26
@sonarcloud
Copy link

sonarcloud bot commented Mar 29, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Mar 29, 2023
@rm3l
Copy link
Member Author

rm3l commented Mar 29, 2023

/override OpenShift-Integration-tests/OpenShift-Integration-tests
/override odo-podman-test

Doc-only PR.

@openshift-ci
Copy link

openshift-ci bot commented Mar 29, 2023

@rm3l: /override requires failed status contexts, check run or a prowjob name to operate on.
The following unknown contexts/checkruns were given:

  • odo-podman-test

Only the following failed contexts/checkruns were expected:

  • Kubernetes-Integration-Tests/Kubernetes-Integration-Tests
  • ODO-PODMAN-TEST
  • OpenShift-Integration-tests/OpenShift-Integration-tests
  • Unit-Tests/Unit-Tests
  • ci/prow/v4.13-images
  • netlify/odo-docusaurus-preview/deploy-preview
  • pull-ci-redhat-developer-odo-main-v4.13-images
  • tide
  • validator/Validate

If you are trying to override a checkrun that has a space in it, you must put a double quote on the context.

In response to this:

/override OpenShift-Integration-tests/OpenShift-Integration-tests
/override odo-podman-test

Doc-only PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@rm3l
Copy link
Member Author

rm3l commented Mar 29, 2023

/override ODO-PODMAN-TEST

@openshift-ci
Copy link

openshift-ci bot commented Mar 29, 2023

@rm3l: Overrode contexts on behalf of rm3l: ODO-PODMAN-TEST

In response to this:

/override ODO-PODMAN-TEST

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@rm3l
Copy link
Member Author

rm3l commented Mar 29, 2023

/override OpenShift-Integration-tests/OpenShift-Integration-tests

@openshift-ci
Copy link

openshift-ci bot commented Mar 29, 2023

@rm3l: Overrode contexts on behalf of rm3l: OpenShift-Integration-tests/OpenShift-Integration-tests

In response to this:

/override OpenShift-Integration-tests/OpenShift-Integration-tests

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-merge-robot openshift-merge-robot merged commit cb5d20d into redhat-developer:main Mar 29, 2023
@rm3l rm3l deleted the 6646-blog-post-devfile-registry-operator-using-in-cluster-registries-with-odo branch March 29, 2023 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation or the 'odo.dev' website lgtm Indicates that a PR is ready to be merged. Required by Prow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Blog Post: Devfile Registry Operator (using in-cluster registries with odo)
4 participants