Document how `odo` translates `container` component into Kubernetes resources #6145

rm3l · 2022-09-20T16:00:27Z

What type of PR is this:
/kind documentation
/area documentation

What does this PR do / why we need it:
This adds a new 'Architecture' section under 'Developer Reference' that documents in detail how odo works, for users to understand what odo does in their clusters.

Let me know if I've missed anything, or if you think the structure or style should be different.

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

PR acceptance criteria:

Unit test
Integration test
Documentation

How to test changes / Special notes to the reviewer:
Visit https://deploy-preview-6145--odo-docusaurus-preview.netlify.app/docs/development/architecture/how-odo-works

netlify · 2022-09-20T16:00:31Z

✅ Deploy Preview for odo-docusaurus-preview ready!

Name	Link
🔨 Latest commit	`a72ed69`
🔍 Latest deploy log	https://app.netlify.com/sites/odo-docusaurus-preview/deploys/632c58518ade810008236642
😎 Deploy Preview	https://deploy-preview-6145--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 · 2022-09-20T16:07:50Z

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

odo-robot · 2022-09-20T16:29:28Z

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

odo-robot · 2022-09-20T17:02:47Z

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

odo-robot · 2022-09-20T17:03:07Z

OpenShift Tests on commit 7ac889e finished with errors.
View logs: TXT HTML

odo-robot · 2022-09-20T17:52:31Z

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

…esources

The default one makes the highlighted line hardly readable

…netes resources

valaparthvi

This is an excellent article, great work, Armel!

I have a few nitpicks that I have suggested. Apart from them, can you ensure you add a period '.' to all the sentences in the tables? I have pointed a few and but not all.

docs/website/docs/development/architecture/how-odo-works.md

valaparthvi · 2022-09-22T04:07:36Z

docs/website/docs/development/architecture/how-odo-works.md

+   running containers.
+   Note that synchronization and push to the cluster can also be triggered on demand by pressing `p` at any time.
+   See [this page](../../command-reference/dev#applying-local-changes-to-the-application-on-the-cluster) for more details.
+6. `odo` optionally restarts the running application (if the command is not marked as `hotReloadCapable` in the Devfile).


This point is not very clear to me. How and when does it restart a running application? Or if this point is a part of point 5, then it makes sense, but then I would merge them both.

Adding more clarification on this.

docs/website/docs/development/architecture/how-odo-works.md

valaparthvi · 2022-09-22T05:01:57Z

docs/website/docs/development/architecture/how-odo-works.md

+
+By default, `odo` adds the following labels to the Service:
+
+| Key                                    | Description                                                                                                                                          | Example Value       |


These labels are the same as Deployments, no? Perhaps you don't need to redefine them and simply point to that section?

Yup, they are the same. I'll list them under a dedicated section.

dharmit · 2022-09-22T08:19:33Z

Amazing work, @rm3l! Thanks for putting this together.

/approve

openshift-ci · 2022-09-22T08:19:40Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dharmit

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~docs/OWNERS~~ [dharmit]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

feloy

Great work!

feloy · 2022-09-22T08:36:33Z

docs/website/docs/development/architecture/how-odo-works.md

+
+   If the Devfile contains any [`Kubernetes` components](../../development/devfile#components) not referenced by any [`apply` command](https://devfile.io/docs/2.2.0-alpha/adding-apply-commands),
+   `odo dev` automatically applies them.
+   This is the mechanism used by [`odo add binding`](../../command-reference/add-binding) to have `ServiceBinding` resources created by `odo dev`. 


This is the mechanism used by odo add binding to have ServiceBinding resources created by odo dev.

You are saying too much, or not enough: you could point to a specific paragraph where this is explained in more details, or remove this part, as it is not clearly understandable as is.

I was hesitant to add a dedicated section about how odo handles Devfile kubernetes components. But you're right, it is currently a bit confusing. Removing this sentence for now - this could be the scope of a separate PR.

docs/website/docs/development/architecture/how-odo-works.md

feloy · 2022-09-22T08:47:09Z

docs/website/docs/development/architecture/how-odo-works.md

+   This is the mechanism used by [`odo add binding`](../../command-reference/add-binding) to have `ServiceBinding` resources created by `odo dev`. 
+3. Once the resources are ready, `odo` executes any `build` (optional) and `run` (or `debug`) commands defined in the Devfile into the right containers.   
+4. It reacts to events occurring in the cluster and that might affect the resources managed.
+5. Unless told otherwise (when running `odo dev --no-watch`), `odo` watches for local changes


I would move the execption (Unless told otherwise...) later in the sentence, to start with the important thing: odo watches for local changes

docs/website/docs/development/architecture/how-odo-works.md

feloy · 2022-09-22T09:15:31Z

docs/website/docs/development/architecture/how-odo-works.md

+
+</details>
+
+#### Volumes


I thin kyou should also tell somewhere in the page that odo can also create PersistentVolumeClaim resources when Volume are defined in Devfile or when Ephemeral is false.

Co-authored-by: Parthvi Vala <pvala@redhat.com> Co-authored-by: Philippe Martin <phmartin@redhat.com>

sonarcloud · 2022-09-22T12:43:40Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

feloy · 2022-09-22T12:52:31Z

/lgtm

rm3l · 2022-09-22T13:38:24Z

• [FAILED] [395.351 seconds]
odo add binding command tests
/go/odo_1/tests/integration/cmd_add_binding_test.go:13
  when the component is bootstrapped
  /go/odo_1/tests/integration/cmd_add_binding_test.go:153
    when adding a binding (current namespace)
    /go/odo_1/tests/integration/cmd_add_binding_test.go:219
      when odo dev is run [BeforeEach]
      /go/odo_1/tests/integration/cmd_add_binding_test.go:260
        when odo dev command is stopped
        /go/odo_1/tests/integration/cmd_add_binding_test.go:265
          should have successfully delete the binding
          /go/odo_1/tests/integration/cmd_add_binding_test.go:271
...
 ✓  Pod is Running
      Error occurred on Push - watch command was unable to push component: some servicebindings are not injected
      
      Error occurred on Push - watch command was unable to push component: some servicebindings are not injected

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

This is a doc-only PR.

openshift-ci · 2022-09-22T13:38:27Z

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

In response to this:

• [FAILED] [395.351 seconds]
odo add binding command tests
/go/odo_1/tests/integration/cmd_add_binding_test.go:13
 when the component is bootstrapped
 /go/odo_1/tests/integration/cmd_add_binding_test.go:153
   when adding a binding (current namespace)
   /go/odo_1/tests/integration/cmd_add_binding_test.go:219
     when odo dev is run [BeforeEach]
     /go/odo_1/tests/integration/cmd_add_binding_test.go:260
       when odo dev command is stopped
       /go/odo_1/tests/integration/cmd_add_binding_test.go:265
         should have successfully delete the binding
         /go/odo_1/tests/integration/cmd_add_binding_test.go:271
...
✓  Pod is Running
     Error occurred on Push - watch command was unable to push component: some servicebindings are not injected
     
     Error occurred on Push - watch command was unable to push component: some servicebindings are not injected

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

This is a 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.

…esources (redhat-developer#6145) * Document how `odo` translates `container` component into Kubernetes resources * Use different background color for highlighted code line The default one makes the highlighted line hardly readable * fixup! Document how `odo` translates `container` component into Kubernetes resources * Apply code review suggestions Co-authored-by: Parthvi Vala <pvala@redhat.com> Co-authored-by: Philippe Martin <phmartin@redhat.com> Co-authored-by: Parthvi Vala <pvala@redhat.com> Co-authored-by: Philippe Martin <phmartin@redhat.com>

openshift-ci bot added kind/documentation area/documentation Issues or PRs related to documentation or the 'odo.dev' website labels Sep 20, 2022

openshift-ci bot requested review from cdrage and feloy September 20, 2022 16:00

rm3l force-pushed the 5174-document-how-odo-translates-container-component-to-deployment branch from 76a774d to eab60a7 Compare September 20, 2022 16:06

rm3l requested a review from kadel September 20, 2022 16:06

rm3l added 2 commits September 21, 2022 09:59

Document how odo translates container component into Kubernetes r…

a1b2def

…esources

Use different background color for highlighted code line

fdc1dfd

The default one makes the highlighted line hardly readable

rm3l force-pushed the 5174-document-how-odo-translates-container-component-to-deployment branch from 7d9c44e to fdc1dfd Compare September 21, 2022 08:00

rm3l requested review from valaparthvi and dharmit September 21, 2022 11:50

fixup! Document how odo translates container component into Kuber…

1d3ed48

…netes resources

valaparthvi suggested changes Sep 22, 2022

View reviewed changes

openshift-ci bot assigned valaparthvi Sep 22, 2022

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Sep 22, 2022

feloy suggested changes Sep 22, 2022

View reviewed changes

openshift-ci bot assigned feloy Sep 22, 2022

Apply code review suggestions

a72ed69

Co-authored-by: Parthvi Vala <pvala@redhat.com> Co-authored-by: Philippe Martin <phmartin@redhat.com>

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Sep 22, 2022

openshift-merge-robot merged commit 1c0ec66 into redhat-developer:main Sep 22, 2022

rm3l deleted the 5174-document-how-odo-translates-container-component-to-deployment branch December 1, 2022 16:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document how `odo` translates `container` component into Kubernetes resources #6145

Document how `odo` translates `container` component into Kubernetes resources #6145

rm3l commented Sep 20, 2022 •

edited

Loading

netlify bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

valaparthvi left a comment

valaparthvi Sep 22, 2022

rm3l Sep 22, 2022

valaparthvi Sep 22, 2022

rm3l Sep 22, 2022

dharmit commented Sep 22, 2022

openshift-ci bot commented Sep 22, 2022

feloy left a comment

feloy Sep 22, 2022

rm3l Sep 22, 2022 •

edited

Loading

feloy Sep 22, 2022

feloy Sep 22, 2022

sonarcloud bot commented Sep 22, 2022

feloy commented Sep 22, 2022

rm3l commented Sep 22, 2022

openshift-ci bot commented Sep 22, 2022


		By default, `odo` adds the following labels to the Service:

		\| Key \| Description \| Example Value \|


		</details>

		#### Volumes

Document how odo translates container component into Kubernetes resources #6145

Document how odo translates container component into Kubernetes resources #6145

Conversation

rm3l commented Sep 20, 2022 • edited Loading

netlify bot commented Sep 20, 2022 • edited Loading

✅ Deploy Preview for odo-docusaurus-preview ready!

odo-robot bot commented Sep 20, 2022 • edited Loading

odo-robot bot commented Sep 20, 2022 • edited Loading

odo-robot bot commented Sep 20, 2022 • edited Loading

odo-robot bot commented Sep 20, 2022 • edited Loading

odo-robot bot commented Sep 20, 2022 • edited Loading

valaparthvi left a comment

Choose a reason for hiding this comment

valaparthvi Sep 22, 2022

Choose a reason for hiding this comment

rm3l Sep 22, 2022

Choose a reason for hiding this comment

valaparthvi Sep 22, 2022

Choose a reason for hiding this comment

rm3l Sep 22, 2022

Choose a reason for hiding this comment

dharmit commented Sep 22, 2022

openshift-ci bot commented Sep 22, 2022

feloy left a comment

Choose a reason for hiding this comment

feloy Sep 22, 2022

Choose a reason for hiding this comment

rm3l Sep 22, 2022 • edited Loading

Choose a reason for hiding this comment

feloy Sep 22, 2022

Choose a reason for hiding this comment

feloy Sep 22, 2022

Choose a reason for hiding this comment

sonarcloud bot commented Sep 22, 2022

feloy commented Sep 22, 2022

rm3l commented Sep 22, 2022

openshift-ci bot commented Sep 22, 2022

Document how `odo` translates `container` component into Kubernetes resources #6145

Document how `odo` translates `container` component into Kubernetes resources #6145

rm3l commented Sep 20, 2022 •

edited

Loading

netlify bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

odo-robot bot commented Sep 20, 2022 •

edited

Loading

rm3l Sep 22, 2022 •

edited

Loading