Documentation: How odo supports exec on Deploy #6672
Conversation
openshift-ci
bot
added
area/documentation
✅ Deploy Preview for odo-docusaurus-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
valaparthvi
force-pushed
the
doc_exec_deploy
branch
from
7a34185 to
7f8e045
Compare
Signed-off-by: Parthvi Vala <[email protected]>
valaparthvi
force-pushed
the
doc_exec_deploy
branch
from
7f8e045 to
ab12852
Compare
Co-authored-by: Philippe Martin <[email protected]>
Signed-off-by: Parthvi Vala <[email protected]>
Co-authored-by: Armel Soro <[email protected]>
Signed-off-by: Parthvi Vala <[email protected]>
There was a problem hiding this comment.
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 <[email protected]>
valaparthvi
force-pushed
the
doc_exec_deploy
branch
from
e109440 to
37214f0
Compare
Co-authored-by: Armel Soro <[email protected]>
| 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). |
There was a problem hiding this comment.
🤔 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/
There was a problem hiding this comment.
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 <[email protected]>
valaparthvi
force-pushed
the
doc_exec_deploy
branch
from
9482702 to
c793511
Compare
Signed-off-by: Parthvi Vala <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
openshift-ci
bot
added
the
lgtm
|
/override NoCluster-Integration-tests/NoCluster-Integration-tests |
|
@valaparthvi: Overrode contexts on behalf of valaparthvi: NoCluster-Integration-tests/NoCluster-Integration-tests, windows-integration-test/Windows-test In response to this:
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. |
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