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

display environment variables in odo describe component #6419

Closed
3 tasks
kadel opened this issue Dec 15, 2022 · 5 comments
Closed
3 tasks

display environment variables in odo describe component #6419

kadel opened this issue Dec 15, 2022 · 5 comments
Labels
kind/user-story An issue of user-story kind lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done.

Comments

@kadel
Copy link
Member

kadel commented Dec 15, 2022

/kind user-story

User Story

As an IDE plugin developer, I want to know where the source code in the container is located So that I can specify the mapping between source files on the local machine and the remote container.

Acceptance Criteria

  • odo describe component should display all environment variables for each container container
  • odo describe component -o json should display all environment variables for each container container
  • If the application is created on cluster (in dev or deploy mode) the variable list should also contain all extra variables that are automatically injected by odo like PROJECTS_ROOT and PROJECT_SOURCE or any additional variables. In other words, if it is created on a cluster, it should display all variables defined in the container spec.

Notes

  • Case of environment variables referencing a Secret or ConfigMap ? We could just display the keys in the first place

example

▶ odo describe component
Name: nodejs-starter
Display Name: Node.js Runtime
Project Type: Node.js
Language: JavaScript
Version: 2.1.1
Description: Stack with Node.js 16
Tags: Node.js, Express, ubi8

Running in: Dev

Forwarded ports:
 •  127.0.0.1:40001 -> runtime:3000
 •  127.0.0.1:40002 -> runtime:5858

Supported odo features:
 •  Dev: true
 •  Deploy: true
 •  Debug: false

Container components:
 •  runtime
    Environment variables:
     • FOO: bar
     • DEBUG_PORT: 5858
     • PROJECT_SOURCE: /project
     • PROJECTS_ROOT: /project
 •  build
    Environment variables:
     • FOO1: bar1
     • PROJECT_SOURCE: /project
     • PROJECTS_ROOT: /project

▶ odo describe component -o json
{
	"devfilePath": "/Users/tkral/Code/odo-examples/nodejs-starter/devfile.yaml",
	"devfileData": {
		"devfile": {
			"schemaVersion": "2.2.0",
			"metadata": {
				"name": "nodejs-starter",
				"version": "2.1.1",
				"displayName": "Node.js Runtime",
				"description": "Stack with Node.js 16",
				"tags": [
					"Node.js",
					"Express",
					"ubi8"
				],
				"icon": "https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg",
				"projectType": "Node.js",
				"language": "JavaScript"
			},
			"components": [
				{
					"name": "runtime",
					"container": {
						"image": "registry.access.redhat.com/ubi8/nodejs-16:latest",
						"env": [
							{
								"name": "DEBUG_PORT",
								"value": "5858"
							},
							{
								"name": "FOO",
								"value": "bar"
							},
							{
								"name": "PROJECT_SOURCE",
								"value": "/projects"
							},
							{
								"name": "PROJECTS_ROOT",
								"value": "/projects"
							}
                                                 ]

Links

/kind user-story

@openshift-ci openshift-ci bot added the kind/user-story An issue of user-story kind label Dec 15, 2022
@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Dec 15, 2022
@kadel kadel added priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)). and removed needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. labels Dec 15, 2022
@rm3l
Copy link
Member

rm3l commented Jan 4, 2023

/priority Medium

Reducing the priority of this issue, since #6453 has been specifically created to address the original need described here (knowing where the source code in the container is located).

@openshift-ci openshift-ci bot added the priority/Medium Nice to have issue. Getting it done before priority changes would be great. label Jan 4, 2023
@rm3l rm3l removed the priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)). label Jan 4, 2023
@github-actions
Copy link
Contributor

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 16, 2023
@rm3l rm3l removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 19, 2023
@github-actions
Copy link
Contributor

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 18, 2023
@rm3l rm3l added priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done. and removed priority/Medium Nice to have issue. Getting it done before priority changes would be great. labels Oct 18, 2023
@github-actions github-actions bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 30, 2023
Copy link
Contributor

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 29, 2024
Copy link
Contributor

This issue was closed because it has been inactive for 30 days since being marked as stale.

@github-actions github-actions bot added the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Feb 29, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/user-story An issue of user-story kind lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done.
Projects
Archived in project
Development

No branches or pull requests

2 participants