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

Documentation: How odo supports exec on Deploy #6672

Merged

Conversation

valaparthvi
Copy link
Contributor

@valaparthvi valaparthvi commented Mar 22, 2023

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

What does this PR do / why we need it:
This doc is a reference to how odo runs exec commands in Deploy mode.
Which issue(s) this PR fixes:

Fixes #

PR acceptance criteria:

  • Unit test

  • Integration test

  • Documentation

How to test changes / Special notes to the reviewer:
https://deploy-preview-6672--odo-docusaurus-preview.netlify.app/docs/development/devfile#how-odo-runs-exec-commands-in-deploy-mode
https://deploy-preview-6672--odo-docusaurus-preview.netlify.app/docs/command-reference/deploy

@openshift-ci openshift-ci bot added area/documentation Issues or PRs related to documentation or the 'odo.dev' website kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation labels Mar 22, 2023
@netlify
Copy link

netlify bot commented Mar 22, 2023

Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit bc19fb4
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/641d7309585fe20008bf8496
😎 Deploy Preview https://deploy-preview-6672--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 requested review from feloy and kadel March 22, 2023 08:43
@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

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

@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

NoCluster Tests on commit 540ce55 finished with errors.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

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

docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

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

@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

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

@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

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

@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

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

Signed-off-by: Parthvi Vala <pvala@redhat.com>
@odo-robot
Copy link

odo-robot bot commented Mar 22, 2023

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

valaparthvi and others added 2 commits March 22, 2023 14:47
Co-authored-by: Philippe Martin <contact@elol.fr>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
@valaparthvi valaparthvi requested a review from feloy March 22, 2023 09:48
Copy link
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

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

Added a few minor comments.

docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
docs/website/docs/development/devfile.md Outdated Show resolved Hide resolved
valaparthvi and others added 2 commits March 23, 2023 13:51
Co-authored-by: Armel Soro <armel@rm3l.org>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
Copy link
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

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

I was just thinking: maybe we could also add a link to this page in the odo deploy command reference page.. Because the command reference never mentions support for exec commands.

Signed-off-by: Parthvi Vala <pvala@redhat.com>
Co-authored-by: Armel Soro <armel@rm3l.org>
The `deploy` command is typically a *composite* command, composed of several *apply* and *exec* commands:
- an `apply` command referencing an `image` component that, when applied, will build the image of the container to deploy, and push it to its registry,
- an `apply` command referencing a [`kubernetes` component](https://devfile.io/docs/2.2.0/defining-kubernetes-resources) that, when applied, will create a Kubernetes resource in the cluster.
- an `exec` command referencing a container component that, when applied, will run the command defined by `commandLine` inside a container started by a Kubernetes Job; read more about it [here](../../development/devfile#how-odo-runs-exec-commands-in-deploy-mode).
Copy link
Member

@rm3l rm3l Mar 24, 2023

Choose a reason for hiding this comment

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

🤔 It's weird - the build is failing on Netlify due to a broken link : https://app.netlify.com/sites/odo-docusaurus-preview/deploys/641d419c585fe20008b8c41a
But with the previous change, my browser could not resolve the link:

Screencast.from.2023-03-24.09-19-03.webm

Do you have similar issues with this page: https://deploy-preview-6672--odo-docusaurus-preview.netlify.app/docs/command-reference/deploy/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am reverting the previous commit because it was working fine for me, at least locally. I am going to test it one more time here.

This reverts commit ac8f66b.

Signed-off-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Parthvi Vala <pvala@redhat.com>
@sonarcloud
Copy link

sonarcloud bot commented Mar 24, 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
0.3% 0.3% Duplication

@valaparthvi valaparthvi requested a review from rm3l March 24, 2023 09:58
Copy link
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

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

Works better now - thanks!

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

/override NoCluster-Integration-tests/NoCluster-Integration-tests
/override windows-integration-test/Windows-test
Doc PR.

@openshift-ci
Copy link

openshift-ci bot commented Mar 24, 2023

@valaparthvi: Overrode contexts on behalf of valaparthvi: NoCluster-Integration-tests/NoCluster-Integration-tests, windows-integration-test/Windows-test

In response to this:

/override NoCluster-Integration-tests/NoCluster-Integration-tests
/override windows-integration-test/Windows-test
Doc 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.

@openshift-merge-robot openshift-merge-robot merged commit 52eb77a into redhat-developer:main Mar 24, 2023
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 kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation 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.

4 participants