Giter Site home page Giter Site logo

docker-desktop-extension's Introduction

Okteto: A Tool to Develop Applications on Kubernetes

CircleCI CII Best Practices GitHub release Apache License 2.0 Total Downloads Chat in Slack

Overview

Kubernetes has made it very easy to deploy applications to the cloud at a higher scale than ever, but development practices have not evolved at the same speed as application deployment patterns.

Today, most developers try to either run parts of the infrastructure locally or just test their integrations directly in the cluster via CI jobs, or the docker build/redeploy cycle. It works, but this workflow is painful and incredibly slow.

okteto accelerates the development workflow of Kubernetes applications. You write your code locally and okteto detects the changes and instantly updates your Kubernetes applications.

How it works

Okteto enables development inside a container, providing a seamless IDE and tool integration as if you were working locally but with the resources of a remote cluster. When you run okteto up your Kubernetes deployment is replaced by a Development Container that contains your development tools (e.g. maven and jdk, or npm, python, go compiler, debuggers, etc). This development container can use any docker image. The development container inherits the same secrets, configmaps, volumes or any other configuration value of the original Kubernetes deployment.

The end result is a remote cluster that is seen by your IDE and tools as a local filesystem/environment. You keep writing code on your local IDE and as soon as you save a file, the change goes to the development container, and your application instantly updates (taking advantage of any hot-reload mechanism you already have). This whole process happens in an instant. No docker images need to be created and no Kubernetes manifests need to be applied to the cluster.

Why Okteto

okteto has several advantages when compared to more traditional development approaches:

  • Fast inner loop development: build and run your application using your favorite tools directly from your development container. Native builds are always faster than the docker build/redeploy cycle.
  • Realistic development environment: your development container reuses the same variables, secrets, sidecars, volumes as your original Kubernetes deployment. Realistic environments eliminate integration issues.
  • Replicability: development containers eliminate the need to install your dependencies locally, everything is pre-configured in your development image.
  • Unlimited resources: get access to the hardware and network of your cluster when developing your application.
  • Deployment independent: okteto decouples deployment from development. You can deploy your application with kubectl, Helm, a serverless framework, or even a CI pipeline and use okteto up to develop it. This is especially useful for cloud-native applications where deployment pipelines are not trivial.
  • Works anywhere: okteto works with any Kubernetes cluster, local or remote. okteto is also available for macOS, Linux, and Windows.

Getting started

All you need to get started is to install the Okteto CLI and have access to a Kubernetes cluster. You can follow our guide for setting up a Kubernetes cluster on AWS here.

The Okteto CLI has two operational modes:

  • Okteto Open Source CLI
  • Okteto Platform CLI

Okteto Open Source CLI Features

Okteto Open Source requires access to a Kubernetes cluster. It's designed to support Development Containers in any Kubernetes cluster. It doesn't come with features that support multiple developers working on the same cluster. That's the goal of the Okteto Platform

Okteto Open Source supports the following commands:

  • okteto context
  • okteto up
  • okteto down

For reference, our Open Source CLI supports the dev section of the Okteto Manifest.

We have getting started guides for the Open Source mode for the following languages:

Okteto Platform CLI Features

The Okteto Platform CLI requires installation of the Okteto Helm Chart in your Kubernetes cluster. In this mode, all of the Okteto CLI commands are available (build, deploy, up, down, destroy, etc). The Okteto Platform comes with additional features like:

  • User authentication and access control to Kubernetes using your own Identity provider
  • Build service for remote container image creation
  • Preview environments for every pull request
  • Dynamic scaling of environments based on usage
  • Secrets manager for your development environments
  • Okteto Insights to provide observability on your development environments

And much more! Refer to the Okteto Platform docs to learn more.

Features Comparison

Feature Okteto Open Source CLI Okteto Platform CLI
Development Containers Available Available
Build Service Not Available Available
User Management Not Available Available
Access Control Not Available Available
Automated Scaling Not Available Available
Secrets Management Not Available Available
Observability Tools Not Available Available
Support Community Support Professional Support
Documentation Open Source Samples Platform Docs

Useful links

Releases

Okteto is monthly released into three channels: stable, beta, and dev. By default when Okteto is installed, the stable channel is used. If you need to access features not yet widely available you can install from the beta or dev channel. More information can be found in the release documentation.

Support and Community

Got questions? Have feedback? Join the conversation in our Community Forum. You can also join us in the #okteto Slack channel! If you don't already have a Kubernetes Slack account, sign up here.

Follow @OktetoHQ on Twitter for important announcements.

✨ Contributions

We ❤️ contributions big or small. See our guide on how to get started.

Thanks to all our contributors!

docker-desktop-extension's People

Contributors

heartbeat1608 avatar pchico83 avatar rlamana avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

docker-desktop-extension's Issues

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:
    VSCode Button Mock

  • Editor selector mock:
    VSCode Button Mock - 2

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).

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.

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.

Relaunch Button Mock

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

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:
Status 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

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.

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.

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

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.