Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

Commit 26c90d7

Browse files
feloyrm3l
andauthored
Remove podman from experimental mode (#6628)
* Remove podman from experimental mode * Remove env var for odo dev * Cleanup tests and sources about experimental mode * Hide "Experimental mode" doc page * Cleanup latest commit * doc odo dev --platform podman * Doc other commands * Apply suggestions from code review Co-authored-by: Armel Soro <armel@rm3l.org> * Remove more ODO_EXPERIMENTAL_MODE from latest commits on main * Remove reference to Experimental mode from blog posts --------- Co-authored-by: Armel Soro <armel@rm3l.org>
1 parent 851b171 commit 26c90d7

29 files changed

Lines changed: 154 additions & 386 deletions

‎docs/website/blog/2022-11-29-odo-v3.3.0.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ https://www.youtube.com/playlist?list=PLGMB2PY4SNOr5pjbPTdcWsIrOezCPXWdX
2525
<iframe width="560" height="315" src="https://www.youtube.com/embed/SkrkvQew2X0" title="Experimental Mode" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
2626

2727
There is now an Experimental Mode in `odo` that can be enabled by exporting `ODO_EXPERIMENTAL_MODE=true` to your environment. All the new features will be generally available under this mode, giving you an opportunity to try them out sooner.
28-
Learn more about the experimental mode in [this doc](../docs/user-guides/advanced/experimental-mode).
2928

3029
#### `odo dev` using Podman ([#6151](https://github.com/redhat-developer/odo/pull/6151))
3130
<iframe width="560" height="315" src="https://www.youtube.com/embed/EmN_hGkOHX4?list=PLGMB2PY4SNOr5pjbPTdcWsIrOezCPXWdX" title="odo dev using podman" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

‎docs/website/blog/2022-12-13-odo-v3.4.0.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Example:
5050
#### Using `odo` with Podman
5151

5252
Based on your valuable feedback, we have worked on improving the experience of using `odo` with Podman.
53-
Note that this is still [experimental](../docs/user-guides/advanced/experimental-mode) and requires you to [opt in](../docs/user-guides/advanced/experimental-mode#enabling-the-experimental-mode) if you want to try it out.
53+
Note that this is still experimental and requires you to opt in if you want to try it out.
5454

5555
- In [#6329](https://github.com/redhat-developer/odo/pull/6329), we have added labels to resources created by `odo` on Podman, so we can easily identify and use them. This adds the same labels depicted in [How odo works](../docs/development/architecture/how-odo-works#resource-labels).
5656
- With [#6366](https://github.com/redhat-developer/odo/pull/6366), `odo list component` is now able to list components running on Podman.

‎docs/website/blog/2023-01-30-local-container-dev-on-podman.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,8 @@ If you skipped Step 0 and selected "starter project", your output will be slight
146146
### Step 2. Enabling the experimental mode
147147

148148
Because the support for Podman is still experimental at the time of writing, we first need to explicitly opt-in.
149-
Find more details about the experimental mode on this [dedicated page](../../docs/user-guides/advanced/experimental-mode).
150149

151-
[Enabling the experimental mode](../../docs/user-guides/advanced/experimental-mode#enabling-the-experimental-mode) can be done by setting the `ODO_EXPERIMENTAL_MODE` environment variable to `true` in the terminal session, like so:
150+
Enabling the experimental mode can be done by setting the `ODO_EXPERIMENTAL_MODE` environment variable to `true` in the terminal session, like so:
152151

153152
```console
154153
export ODO_EXPERIMENTAL_MODE=true

‎docs/website/blog/2023-02-15-odo-v3.7.0.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Similarly to how `odo dev` requires specifying the target platform (using the `-
2828
ODO_EXPERIMENTAL_MODE=t odo logs --platform podman
2929
```
3030

31-
As a reminder, Podman support in `odo` is still [experimental](../docs/user-guides/advanced/experimental-mode) and requires you to [opt in](../docs/user-guides/advanced/experimental-mode#enabling-the-experimental-mode) if you want to try it out.
31+
As a reminder, Podman support in `odo` is still experimental and requires you to opt in if you want to try it out.
3232

3333
<iframe width="560" height="315" src="https://www.youtube.com/embed/K5GsDFEgCW0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
3434

‎docs/website/docs/command-reference/delete-component.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ toc_max_heading_level: 4
55
---
66

77
`odo delete component` command is useful for deleting resources that are managed by `odo`.
8-
By default, it deletes the component and its related inner-loop, and outer-loop resources from the cluster.
9-
But the `running-in` flag allows to be more specific about which resources (either inner-loop or outer-loop) to delete.
8+
By default, it deletes the component and its related inner-loop, and outer-loop resources from the cluster and from podman.
9+
10+
The `running-in` flag allows to be more specific about which resources (either inner-loop or outer-loop) to delete.
11+
12+
The `platform` flag allows to restrict the deletion from a specific platform only, either cluster or podman.
1013

1114
## Running the command
1215
There are 2 ways to delete a component:
@@ -31,14 +34,16 @@ If these resources have been deployed on the cluster, then `odo` will delete the
3134
Otherwise, `odo` will exit with a message stating that it could not find the resources on the cluster.
3235

3336
:::note
34-
If some resources attached to the component are present on the cluster, but not in the Devfile, then they will not be deleted.
37+
If some resources attached to the component are present on the cluster or on podman, but not in the Devfile, then they will not be deleted.
3538
You can delete these resources by running the command in the [next section](#delete-without-access-to-devfile).
3639
:::
3740

3841
#### Filtering resources to delete
3942
You can specify the type of resources candidate for deletion via the `--running-in` flag.
4043
Acceptable values are `dev` (for inner-loop resources) or `deploy` (for outer-loop resources).
4144

45+
You can target a specific platform from which delete the resources, with the `--platform` flag. Acceptable values are `cluster` and `podman`.
46+
4247
<details>
4348
<summary>Example</summary>
4449

@@ -91,16 +96,18 @@ import DeleteNamedComponentOutput from './docs-mdx/delete-component/delete_named
9196
</details>
9297

9398

94-
`odo` searches for resources attached to the given component in the given namespace on the cluster.
99+
`odo` searches for resources attached to the given component in the given namespace on the cluster and on Podman.
95100
If `odo` finds the resources, it will delete them after user confirmation.
96-
Otherwise, `odo` will exit with a message stating that it could not find the resources on the cluster.
101+
Otherwise, `odo` will exit with a message stating that it could not find the resources on the cluster or on Podman.
97102

98103
`--namespace` is optional, if not provided, `odo` will use the current active namespace.
99104

100105
#### Filtering resources to delete
101106
You can specify the type of resources candidate for deletion via the `--running-in` flag.
102107
Acceptable values are `dev` (for inner-loop resources) or `deploy` (for outer-loop resources).
103108

109+
You can target a specific platform from which to delete the resources, with the `--platform` flag. Acceptable values are `cluster` and `podman`.
110+
104111
<details>
105112
<summary>Example</summary>
106113

‎docs/website/docs/command-reference/describe-component.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: odo describe component
33
---
44

5-
`odo describe component` command is useful for getting information about a component managed by `odo`.
5+
`odo describe component` command is useful for getting information about a component.
66

77
## Running the command
88
There are 2 ways to describe a component:
@@ -59,7 +59,7 @@ This command returns information extracted from the Devfile:
5959
- the list of Kubernetes components.
6060
- the list of forwarded ports if the component is running in Dev mode.
6161

62-
The command also displays if the component is currently running in the cluster on Dev and/or Deploy mode.
62+
The command also displays if the component is currently running in the cluster or in Podman on Dev and/or Deploy mode.
6363

6464
### Describe without access to Devfile
6565

@@ -98,4 +98,8 @@ Kubernetes Routes:
9898

9999
The command extracts information from the labels and annotations attached to the deployed component to display the known metadata of the Devfile used to deploy the component.
100100

101-
The command also displays if the component is currently running in the cluster on Dev and/or Deploy mode.
101+
The command also displays if the component is currently running in the cluster or in Podman on Dev and/or Deploy mode.
102+
103+
### Targeting a specific platform
104+
105+
By default, `odo describe component` will search components in both the current namespace of the cluster and podman. You can restrict the search to one of the platforms only, using the `--platform` flag, giving a value `cluster` or `podman`.

‎docs/website/docs/command-reference/dev.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,43 @@ The following command will override the `USER` Devfile variable with the `john`
244244
odo dev --var USER=john --var-file config.vars
245245
```
246246

247+
### Running on Podman
248+
249+
Instead of deploying the container into a Kubernetes cluster, `odo dev` can leverage the podman installation on your system to deploy the container.
250+
251+
You need to use the `--platform podman` flags to run the component using podman instead of a Kubernetes cluster.
252+
253+
```console
254+
odo dev --platform podman
255+
```
256+
<details>
257+
<summary>Example</summary>
258+
259+
```console
260+
261+
$ odo dev --platform podman
262+
__
263+
/ \__ Developing using the "my-nodejs-app" Devfile
264+
\__/ \ Platform: podman
265+
/ \__/ odo version: v3.7.0
266+
\__/
267+
268+
↪ Running on podman in Dev mode
269+
✓ Deploying pod [4s]
270+
✓ Building your application in container (command: install) [3s]
271+
• Executing the application (command: run) ...
272+
- Forwarding from 127.0.0.1:20001 -> 3000
273+
274+
↪ Dev mode
275+
Status:
276+
Watching for changes in the current directory /path/to/project/nodejs
277+
278+
Keyboard Commands:
279+
[Ctrl+c] - Exit and delete resources from podman
280+
[p] - Manually apply local changes to the application on podman
281+
```
282+
</details>
283+
247284
## Devfile (Advanced Usage)
248285

249286
### Devfile Overview

‎docs/website/docs/command-reference/docs-mdx/delete-component/delete_named_component_running-in.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```shell
2-
$ odo delete component --name my-nodejs --running-in deploy
2+
$ odo delete component --name my-nodejs --running-in deploy --platform cluster
33
Searching resources to delete, please wait...
44
This will delete "my-nodejs" from the namespace "my-project".
55
• The following resources will get deleted from cluster:

‎docs/website/docs/command-reference/docs-mdx/delete-component/delete_running-in_with_access_to_devfile.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```shell
2-
$ odo delete component --running-in dev
2+
$ odo delete component --running-in dev --platform cluster
33
Searching resources to delete, please wait...
44
This will delete "my-nodejs" from the namespace "my-project".
55
• The following resources will get deleted from cluster:

‎docs/website/docs/command-reference/list-component.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: odo list component
33
---
44

5-
`odo list component` command is useful for getting information about components running on a specific namespace.
5+
`odo list component` command is useful for getting information about components running on a specific namespace of a cluster or on Podman.
66

77
If the command is executed from a directory containing a Devfile, it also displays the component
88
defined in the Devfile as part of the list, prefixed with a star(*).
@@ -12,7 +12,8 @@ For each component, the command displays:
1212
- its project type,
1313
- on which mode it is running (None, Dev, Deploy, or both), note that None is only applicable to the component
1414
defined in the local Devfile,
15-
- by which application the component has been deployed.
15+
- by which application the component has been deployed,
16+
- the platform on which the component is running (cluster or podman).
1617

1718
### Running the command
1819
```shell
@@ -24,13 +25,16 @@ odo list component
2425
```shell
2526
$ odo list component
2627
✓ Listing components from namespace 'my-percona-server-mongodb-operator' [292ms]
27-
NAME PROJECT TYPE RUNNING IN MANAGED
28-
* my-nodejs nodejs Deploy odo (v3.0.0-rc1)
29-
my-go-app go Dev odo (v3.0.0-rc1)
30-
mongodb-instance Unknown None percona-server-mongodb-operator
28+
NAME PROJECT TYPE RUNNING IN MANAGED PLATFORM
29+
* my-nodejs nodejs Deploy odo (v3.7) cluster
30+
my-go-app go Dev odo (v3.7) podman
31+
mongodb-instance Unknown None percona-server-mongodb-operator cluster
3132
```
3233
</details>
3334

35+
### Targeting a specific platform
36+
37+
By default, `odo list component` will search components in both the current namespace of the cluster and podman. You can restrict the search to one of the platforms only, using the `--platform` flag, giving a value `cluster` or `podman`.
3438

3539
:::tip use of cache
3640

0 commit comments

Comments
 (0)