okteto / docker-desktop-extension

Docker Extension for Okteto

Docker Extension for Okteto

A new development experience for applications running on Kubernetes.

Overwiew

Do you love Docker Desktop, but your application is starting to get too big for your local machine? The Docker Extension for Okteto is exactly what you need. Get the Docker Desktop experience you love without the restrictions of having to run everything on your local machine.

Try It Out Yourself!

Using the Docker Extension for Okteto is very simple. Once you have the extension installed, simply point it to the location of the Docker compose file or Okteto Manifest describing your services and click the "Deploy Dev Environment" button! In a matter of minutes, all the services you require should be up and running in the cloud.

Useful links

• DockerCon Keynote Demo
• See our guide on how to get started

docker-desktop-extension's Issues

Remove `okteto ctx show` call at initial load and use new field in the `list` command

This will optimize login time

Add screenshots to marketplace by adding the labels to the Dockerfile

Add `--deploy` to the `up` command

We should always redeploy compose changes, it's what docker compose up does.

Add line in output when UP command fails and the process exits or gets killed

send back to docker desktop after login

docker team will send us a link on how to do that

debugging doesn't work on the microservices-demo-compose sample

it looks like port 5005 is not being exposed

"Connected to" link is barely visible when darkmode is not enabled

Display status of the environment in the UI

Is your feature request related to a problem? Please describe.
As of right now there is no way to know if the environment finished launching, whether it failed or not, or if it is ready to use for development.

Describe the solution you'd like
Display the status in the UI by calling the okteto status command.

The status will be a new property in the main view as shown in this mock:

okteto status possible values are: building, deploying, activating, synchronizing, ready, failed

And should be displayed as:

• Building...
• Deploying...
• Activating...
• Synchronizing...
• Ready
• Failed

Additional context
A new command call should be added to the okteto wrapper here: https://github.com/okteto/docker-desktop-extension/blob/main/client/src/api/okteto.ts

Link to docs from the extension

Support for force "build" images when running the dev environment

the 'stop' button doesn't stop okteto

When I click stop, okteto is not stopped. If I then launch the same compose again, it fails to start because the port is taken.

Pass --docker-desktop to `okteto context use` at login

Keep the state of the extension

According to the docker desktop team, they don't have plans to automatically save the extension's state. every time you click out of it, the component is trashed, and the expectation is that the extension will generate its state back when it's loaded again. This means that we need to find a way to either store the state on a volume (maybe a file that describes the status so we don't have to query everything every single time?) or store it in the cloud and rebuild the state every time.

this is not required for Dockercon, but it's something we should do soon since it seriously impacts the usability of the extension.

Improve documentation

Describe the bug
Improve documentation of README.md and contributing.md

Additional context

• Add badges for no. of forks, stars

• Write prior documentation in pointwise manner in short

• Add link to contributing.md in readme

• Add standard Github workflow commands in the CONTRIBUTING.md (opening issues, get assigned, fork, create clone, add, commit, creating PRs).

• It will provide new potential project contributors with a short guide to how they can help with your project.

Configure extension details page

We should configure the following labels on the Dockerfile:

• com.docker.extension.screenshots
• com.docker.extension.detailed-description
• com.docker.extension.publisher-url
• com.docker.extension.additional-urls

More details here

Use Docker API File Picker when ready

This is blocked until Docker releases the changes in their API

Endpoints are not loaded on the UI

This is on Mac ARM

Fix icon in light mode in Windows

Apparently we can use a colored version of the logo, so we can include the standard green Okteto logo

Add a button to open code in editor

Is your feature request related to a problem? Please describe.
When a remote environment is launched and it's ready for development it would be very useful to take users directly to the code to start developing on the new environment.

Describe the solution you'd like
Based on the path to the docker-compose file, a button can be added to open an editor at the same path. On a first iteration, we can create just an "Open in VSCode" button, being VSCode one of the most popular editor nowadays. But in the future we could add support for other editors.

• VSCode button mock:
  

• Editor selector mock:
  

Add a "Relaunch" remote environment button

Is your feature request related to a problem? Please describe.
Once an environment has been launched, there is no way to relaunch it again unless you stop it, select the docker-compose file again and launch as you did the first time.

Describe the solution you'd like
Since we already have the path to the docker-compose file, a "Relaunch" button in the extension UI could trigger a new okteto up call.

Additional context
The relaunch functionality should be as simple as updating the "environment" in the Okteto React context just like it is done here: https://github.com/okteto/docker-desktop-extension/blob/main/client/src/contexts/Okteto.context.tsx#L58

submit proposal for keynote

@rberrelleza will write the abstract, @pchico83 will find us a customer that uses docker-compose on okteto already.

automate publishing a new version to dockerhub

Once we are in the extension store, all we need to do is publish a new version to dockerhub and it will be updated on all Docker Desktop instances. I think that we should have one image for development, and a separate one for "production". We can push the production to dockerhub using a GitHub action or something like that.

Pass --detached to `okteto up`

Switching to a different context should stop current environment and warn/confirm user about it

Add `--docker-desktop` flag to UP call

option to pick a different Okteto instance

Giving demos in Cloud is dangerous since its performance is worse than a team or private instance. would it be useful to have an option (even if it's hidden for now).

Extension's `okteto up` CLI call not working on Windows

@jLopezbarb can you take a look at this?

Command executed:

okteto up -f {manifestFile} --log-output plain

Platform: Windows
Output:

INFO: Using bgonp @ cloud.okteto.com as context
Select the development container you want to activate:
Use the arrow keys to navigate: â â â â
> vote
result
ERROR: Invalid option

In Docker Desktop 4.8.0 okteto process doesn't seem to be killed when clicking the "stop" button

Do not show context selector if there is only Okteto Cloud

context of the extension is gone if I click on any other component of the docker desktop UI

https://www.loom.com/share/223bcb7cf166405394bdd1ee7dc6b7c5

Send dockerhub link to Amy Bass

We need to do this to be on the release. I think we should do this by Friday April 8, so they have time to process it.

verify that our container passes dockerhub rules

Amy from Docker mentioned that: @guillaume Tardif mentioned during today's meeting." @pchico83 can you follow up with Guillaume to see if this is something we can automate? We need this to be able to publish the extension.

Notify when environment is ready

Describe the solution you'd like
Related to #74, using the status of the environment we could notify users when the environment is done deploying and it is ready for development

The Toast API is described here:
https://docs.docker.com/desktop/extensions-sdk/dev/api/reference/interfaces/Toast/

Use the same terminology than docker when talking about the compose file

I think the name is 'Compose file' instead of 'Docker-compose' file. Let's also double-check the casing and all that.

Pass --context as parameter instead of switching user's current context

Depends on okteto/okteto#2022

Add "build" checkbox when launch environment to pass `--build` on `okteto up` call

Label: "Build images before launching environment"