Automatically use in-cluster Devfile registries if any #6622

rm3l · 2023-02-27T11:10:52Z

Co-authored-by: @valaparthvi @feloy @anandrkskd @ritudes

What type of PR is this:
/kind feature

What does this PR do / why we need it:
If connected to a cluster, odo init, odo preference view, odo registry commands will detect any DevfileRegistriesList and ClusterDevfileRegistriesList resources in the cluster, and use the registries listed there.
The same behavior applies to odo dev and odo deploy when there is source code but no devfile.yaml, as they should start by initializing a Devfile.
Per the acceptance criteria, order of registries is as follows:

current namespace registries
cluster registries
local preferences

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

PR acceptance criteria:

Unit test
Integration test
Documentation

How to test changes / Special notes to the reviewer:

If connected to a cluster, you can install the Custom Resource Definitions along with the Custom Resources, and see it in action:

$ kubectl apply -f https://raw.githubusercontent.com/devfile/registry-operator/main/config/crd/bases/registry.devfile.io_clusterdevfileregistrieslists.yaml
$ kubectl apply -f https://raw.githubusercontent.com/devfile/registry-operator/main/config/crd/bases/registry.devfile.io_devfileregistrieslists.yaml
# Cluster-scoped registries list
$ kubectl apply -f https://raw.githubusercontent.com/devfile/registry-operator/main/samples/clusterregistrieslist.yaml
# Namespace-scoped registries list
$ kubectl apply -f https://raw.githubusercontent.com/devfile/registry-operator/main/samples/devfileregistrieslist.yaml

# Now you can use any `odo` command
$ odo preference view

If not connected, it should still work with the registries stored in the odo preferences, like so:

$ KUBECONFIG=/dev/null odo preference view
Preference parameters:
 PARAMETER           VALUE           
 ConsentTelemetry    true            
 Ephemeral           false (default) 
 PushTimeout                         
 RegistryCacheTime                   
 Timeout                             
 UpdateNotification                  

Devfile registries:
 NAME                    URL                                SECURE 
 Staging                 https://registry.stage.devfile.io  No     
 DefaultDevfileRegistry  https://registry.devfile.io        No

openshift-ci · 2023-02-27T11:10:58Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

netlify · 2023-02-27T11:11:01Z

✅ Deploy Preview for odo-docusaurus-preview ready!

Name	Link
🔨 Latest commit	`4afb1c7`
🔍 Latest deploy log	https://app.netlify.com/sites/odo-docusaurus-preview/deploys/64059826ad5b50000897ddaf
😎 Deploy Preview	https://deploy-preview-6622--odo-docusaurus-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

odo-robot · 2023-02-27T11:17:09Z

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

odo-robot · 2023-02-27T11:17:43Z

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

odo-robot · 2023-02-27T11:19:08Z

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

odo-robot · 2023-02-27T11:27:29Z

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

odo-robot · 2023-02-27T11:34:51Z

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

odo-robot · 2023-02-27T11:35:57Z

Windows Tests (OCP) on commit badd717 finished with errors.
View logs: TXT HTML

odo-robot · 2023-02-27T11:41:25Z

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

odo-robot · 2023-02-28T10:36:10Z

Kubernetes Docs Tests on commit 29b5a38 finished with errors.
View logs: TXT HTML

rm3l · 2023-03-02T13:22:31Z

user-guides/quickstart/docs-mdx/nodejs/nodejs_odo_dev_output.mdx
  Expected
      <string>:   (
        	"""
        	... // 9 identical lines
        	•  Waiting for Kubernetes resources  ...
        	⚠  Pod is Pending
      - 	✓  Pod is Running
        	✓  Syncing files into the container [1s]
        	✓  Building your application in container (command: install) [1s]
        	... // 9 identical lines
        	[Ctrl+c] - Exit and delete resources from the cluster
        	[p] - Manually apply local changes to the application on the cluster
      + 	✓  Pod is Running
        	```
        	"""
        )
      
  to be empty
  In [It] at: /go/odo_1/tests/documentation/user-guides/doc_user_guides_quickstart_test.go:104

Addressed in #6545

/override Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests

openshift-ci · 2023-03-02T13:22:35Z

@rm3l: Overrode contexts on behalf of rm3l: Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests

In response to this:

user-guides/quickstart/docs-mdx/nodejs/nodejs_odo_dev_output.mdx
 Expected
     <string>:   (
       	"""
       	... // 9 identical lines
       	•  Waiting for Kubernetes resources  ...
       	⚠  Pod is Pending
     - 	✓  Pod is Running
       	✓  Syncing files into the container [1s]
       	✓  Building your application in container (command: install) [1s]
       	... // 9 identical lines
       	[Ctrl+c] - Exit and delete resources from the cluster
       	[p] - Manually apply local changes to the application on the cluster
     + 	✓  Pod is Running
       	```
       	"""
       )
     
 to be empty
 In [It] at: /go/odo_1/tests/documentation/user-guides/doc_user_guides_quickstart_test.go:104

Addressed in #6545

/override Kubernetes-Integration-Tests/Kubernetes-Docs-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.

rm3l · 2023-03-02T14:27:40Z

Still to do:

odo init interactive mode: it does detect the in-cluster registry, but was not able to use it
odo init non-interactive mode: specifying an in-cluster registry as --devfile-registry returns an error
odo registry --details --defile-registry: errors out if we specify an in-cluster registry

rm3l · 2023-03-03T15:13:17Z

Rebased and force-pushed to fix the conflicts reported.

Co-authored-by: Philippe Martin <[email protected]>

This is yet to be implemented. Co-authored-by: Philippe Martin <[email protected]>

Signed-off-by: anandrkskd <[email protected]>

Co-authored-by: Philippe Martin <[email protected]>

This should ideally not happen if the registry operator is installed in the cluster (because it validates the URL to make sure it is reachable), but you never know ;-)

Registries might be found in the cluster.

…try --details'

Signed-off-by: Parthvi Vala <[email protected]>

Signed-off-by: Parthvi Vala <[email protected]> Co-authored-by: Armel Soro <[email protected]>

…e cluster or if there are cluster-wide registry lists

CRs are now dynamically created and applied from the tests

sonarqubecloud · 2023-03-06T07:39:57Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

feloy · 2023-03-06T08:15:41Z

/override Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests
/override windows-integration-test/Windows-test
Flaky tests

/lgtm

openshift-ci · 2023-03-06T08:15:49Z

@feloy: Overrode contexts on behalf of feloy: Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests, windows-integration-test/Windows-test

In response to this:

/override Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests
/override windows-integration-test/Windows-test
Flaky tests

/lgtm

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.

…per#6622) * Add kubeclient as dependency of the registry client Co-authored-by: Philippe Martin <[email protected]> * Add GetRegistryList method to the kube client interface This is yet to be implemented. Co-authored-by: Philippe Martin <[email protected]> * Implement GetRegistryList * adding test if devfileRegistryListCR is present in cluster Signed-off-by: anandrkskd <[email protected]> * Unit tests (to be continued) * Add unit test cases against kclient#GetRegistryList() Co-authored-by: Philippe Martin <[email protected]> * Ignore in-cluster registries with an empty URL This should ideally not happen if the registry operator is installed in the cluster (because it validates the URL to make sure it is reachable), but you never know ;-) * Update error message when trying to remove registry Registries might be found in the cluster. * Pass isSecure value to the registry handler * Make it possible to use in-cluster registries when calling 'odo registry --details' * Remove unused 'preferenceClient' from registry.getRegistryStacks * Handle in-cluster registries in 'odo init' non-interactive mode * Handle in-cluster registries in 'odo init' interactive mode * Add integration test for odo init --devfile-registry Signed-off-by: Parthvi Vala <[email protected]> * Use proxy when available Signed-off-by: Parthvi Vala <[email protected]> Co-authored-by: Armel Soro <[email protected]> * Make sure tests work even if the registry operator is installed in the cluster or if there are cluster-wide registry lists * Add tests for 'odo init' interactive mode * Remove useless CR file CRs are now dynamically created and applied from the tests * fixup! Add tests for 'odo init' interactive mode --------- Signed-off-by: anandrkskd <[email protected]> Signed-off-by: Parthvi Vala <[email protected]> Co-authored-by: Philippe Martin <[email protected]> Co-authored-by: anandrkskd <[email protected]> Co-authored-by: Parthvi Vala <[email protected]>

rm3l added the area/registry Issues or PRs related to Devfile registries label Feb 27, 2023

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. Required by Prow. label Feb 27, 2023

openshift-ci bot added the kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation label Feb 27, 2023

rm3l changed the title ~~[WIP] Automatically use in-cluster Devfile registries if any~~ Automatically use in-cluster Devfile registries if any Mar 2, 2023

rm3l changed the title ~~Automatically use in-cluster Devfile registries if any~~ [WIP] Automatically use in-cluster Devfile registries if any Mar 2, 2023

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Mar 3, 2023

rm3l force-pushed the 5128-odo-should-automatically-use-cluster-registry-if-cluster-has-one-deployed branch from dd817cd to 3ef5a17 Compare March 3, 2023 15:12

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Mar 3, 2023

rm3l changed the title ~~[WIP] Automatically use in-cluster Devfile registries if any~~ Automatically use in-cluster Devfile registries if any Mar 3, 2023

rm3l marked this pull request as ready for review March 3, 2023 15:51

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. Required by Prow. label Mar 3, 2023

openshift-ci bot requested review from feloy and rnapoles-rh March 3, 2023 15:52

rm3l requested review from valaparthvi and ritudes and removed request for rnapoles-rh March 3, 2023 15:55

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Mar 6, 2023

rm3l and others added 19 commits March 6, 2023 08:36

Add kubeclient as dependency of the registry client

f526466

Co-authored-by: Philippe Martin <[email protected]>

Add GetRegistryList method to the kube client interface

0d8042c

This is yet to be implemented. Co-authored-by: Philippe Martin <[email protected]>

Implement GetRegistryList

0f7cbec

adding test if devfileRegistryListCR is present in cluster

ef31b05

Signed-off-by: anandrkskd <[email protected]>

Unit tests (to be continued)

0020233

Add unit test cases against kclient#GetRegistryList()

5b28bd6

Co-authored-by: Philippe Martin <[email protected]>

Ignore in-cluster registries with an empty URL

11f5ceb

This should ideally not happen if the registry operator is installed in the cluster (because it validates the URL to make sure it is reachable), but you never know ;-)

Update error message when trying to remove registry

84c7e90

Registries might be found in the cluster.

Pass isSecure value to the registry handler

68c5cc0

Make it possible to use in-cluster registries when calling 'odo regis…

daa4553

…try --details'

Remove unused 'preferenceClient' from registry.getRegistryStacks

11425f2

Handle in-cluster registries in 'odo init' non-interactive mode

9ec3d80

Handle in-cluster registries in 'odo init' interactive mode

69f6c5f

Add integration test for odo init --devfile-registry

a9dbab1

Signed-off-by: Parthvi Vala <[email protected]>

Use proxy when available

dd6b84f

Signed-off-by: Parthvi Vala <[email protected]> Co-authored-by: Armel Soro <[email protected]>

Make sure tests work even if the registry operator is installed in th…

67c1876

…e cluster or if there are cluster-wide registry lists

Add tests for 'odo init' interactive mode

6a35667

Remove useless CR file

9b52c79

CRs are now dynamically created and applied from the tests

fixup! Add tests for 'odo init' interactive mode

4afb1c7

feloy force-pushed the 5128-odo-should-automatically-use-cluster-registry-if-cluster-has-one-deployed branch from 85b9a44 to 4afb1c7 Compare March 6, 2023 07:37

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Mar 6, 2023

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Mar 6, 2023

openshift-merge-robot merged commit 4fb7308 into redhat-developer:main Mar 6, 2023

rm3l deleted the 5128-odo-should-automatically-use-cluster-registry-if-cluster-has-one-deployed branch March 6, 2023 08:31

rm3l mentioned this pull request Mar 6, 2023

Support Devfile registries with self-signed or untrusted certificates by allowing to skip TLS checks #6635

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically use in-cluster Devfile registries if any #6622

Automatically use in-cluster Devfile registries if any #6622

rm3l commented Feb 27, 2023 •

edited

Loading

openshift-ci bot commented Feb 27, 2023

netlify bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 28, 2023 •

edited

Loading

rm3l commented Mar 2, 2023

openshift-ci bot commented Mar 2, 2023

rm3l commented Mar 2, 2023 •

edited

Loading

rm3l commented Mar 3, 2023

sonarqubecloud bot commented Mar 6, 2023

feloy commented Mar 6, 2023

openshift-ci bot commented Mar 6, 2023

Automatically use in-cluster Devfile registries if any #6622

Automatically use in-cluster Devfile registries if any #6622

Conversation

rm3l commented Feb 27, 2023 • edited Loading

openshift-ci bot commented Feb 27, 2023

netlify bot commented Feb 27, 2023 • edited Loading

✅ Deploy Preview for odo-docusaurus-preview ready!

odo-robot bot commented Feb 27, 2023 • edited Loading

odo-robot bot commented Feb 27, 2023 • edited Loading

odo-robot bot commented Feb 27, 2023 • edited Loading

odo-robot bot commented Feb 27, 2023 • edited Loading

odo-robot bot commented Feb 27, 2023 • edited Loading

odo-robot bot commented Feb 27, 2023 • edited Loading

odo-robot bot commented Feb 27, 2023 • edited Loading

odo-robot bot commented Feb 28, 2023 • edited Loading

rm3l commented Mar 2, 2023

openshift-ci bot commented Mar 2, 2023

rm3l commented Mar 2, 2023 • edited Loading

rm3l commented Mar 3, 2023

sonarqubecloud bot commented Mar 6, 2023

feloy commented Mar 6, 2023

openshift-ci bot commented Mar 6, 2023

rm3l commented Feb 27, 2023 •

edited

Loading

netlify bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 27, 2023 •

edited

Loading

odo-robot bot commented Feb 28, 2023 •

edited

Loading

rm3l commented Mar 2, 2023 •

edited

Loading