Chapter 3. Developing with Docker in CodeReady Studio

3.1. Managing Docker connections

3.1.1. Setting up a Docker account

The following section describes how to set up a Docker account in CodeReady Studio.

Prerequisites

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Preferences.

    The Preferences window appears.

    crs registry accounts
  3. Enter Registry Accounts in the search field.
  4. Select Registry Accounts.

  5. Click Add.

    The New Registry Account window appears.

    crs docker new account registry
  6. Enter the Server Address.
  7. Enter your Doker ID as the Username.
  8. Enter the email associated with your Docker account.
  9. Enter your password.
  10. Click OK.
  11. Click Apply and Close.

Your Docker account has been set up.

3.1.2. Testing an existing Docker connection

Prerequisites

  • Your Docker account in CodeReady Studio is set up.

    For more information on how to set up a Docker account in CodeReady Studio, see Setting up a Docker account.

  • You are logged in to your Docker account.

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Show View → Other.

    The Show View window appears.

    crs opening docker explorer
  3. Enter Docker in the search field.
  4. Select Docker Explorer.

  5. Click Open.

    The Docker Explorer view appears.

    crs docker explorer

  6. Right-click Docker socket → Edit.

    crs docker socket edit

    The Edit Docker Connection window appears.

    crs docker testing connection

  7. Click Test Connection.

    If the connection is configured correctly, a window stating Ping succeeded! appears.

  8. Click OK.
  9. Click Finish.

3.1.3. Editing a Docker connection

Prerequisites

  • A set up Docker account in CodeReady Studio.

    For more information on how to set up a Docker account in CodeReady Studio, see Setting up a Docker account.

  • You are logged in to your Docker account.

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Show View → Other.

    The Show View window appears.

    crs opening docker explorer
  3. Enter Docker in the search field.
  4. Select Docker Explorer.

  5. Click Open.

    The Docker Explorer view appears.

    crs docker explorer

  6. Right-click Docker socket → Edit.

    crs docker socket edit

    The Edit Docker Connection window appears.

    crs docker testing connection
  7. Click Browse in the Unix socket Location field to locate a new socket or check the TCP Connection option and add your host URI.
  8. Click Finish.

Your docker connection has been edited.

3.2. Managing Docker images

Prerequisites

  • A set up Docker account in CodeReady Studio.

    For more information on how to set up a Docker account in CodeReady Studio, see Setting up a Docker account.

  • You are logged in to your Docker account.

3.2.1. Pulling Docker images

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Show View → Other.

    The Show View window appears.

    crs opening docker explorer
  3. Enter Docker in the search field.
  4. Select Docker Explorer.

  5. Click Open.

    The Docker Explorer view appears.

    crs docker explorer
  6. Expand the Docker socket folder.

  7. Right-click Images → Pull.

    crs docker pull images

    The Pull Image window appears.

    crs docker pull image window

  8. Click Search.

    The Search the Docker Registry for images window appears.

    crs docker pulling wildfly image
  9. Enter your image name into the search field.

  10. Click Next.

    The Choose a tag for the selected image window appears.

    crs docker images tags
  11. Choose a tag for your image.

  12. Click Finish.

    The Pull an image or a repository from the registry window appears.

    crs docker pulling wildfly image2
  13. Click Finish.

Your new Docker image is now listed in the Docker Explorer view.

crs docker pulled image

3.2.2. Pushing Docker images

Before pushing an image you must tag it. The following section describes how to tag and push a Docker image in CodeReady Studio.

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Show View → Other.

    The Show View window appears.

    crs opening docker explorer
  3. Enter Docker in the search field.
  4. Select Docker Explorer.

  5. Click Open.

    The Docker Explorer view appears.

    crs docker explorer
  6. Expand Docker socket → Images.
  7. Right-click the image you want to tag.

  8. Click Add tag.

    crs docker tag image

    The Tag Image window appears.

    crs docker tagging image

  9. Enter your tag in the New Tag field.

    The tag should be in the form of username/image_name:tag_name, where username is your Docker ID on https://hub.docker.com, image_name is the name of your image, and tag_name is the version of your image.

  10. Click Finish.

  11. Right-click the tagged image → Push.

    crs docker pushing tagged image

    The Push image to Registry window appears.

    crs docker image push
  12. Select the Registry Account that starts with your Docker ID.
  13. Click Finish.

After you push the image it appears in the Docker Cloud. This image is then available for other developers to use.

3.2.3. Running Docker images

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Show View → Other.

    The Show View window appears.

    crs opening docker explorer
  3. Enter Docker in the search field.
  4. Select Docker Explorer.

  5. Click Open.

    The Docker Explorer view appears.

    crs docker explorer
  6. Expand Docker socket → Images.
  7. Right-click an image you want to run.

  8. Click Run.

    crs docker running image

    The Docker Container settings window appears.

    crs docker container settings
  9. Name the container.
  10. Clear the Publish all exposed ports to random ports on the host interfaces check box.
  11. Check the box for the 8080 port.

  12. Click Finish.

    The Console view appears showing the process of starting the image.

  13. In the web browser, navigate to http://localhost:8080/ to see the image running.

    crs docker image running

3.2.4. Building images with Dockerfile

You can build or create an image by modifying an existing image. Typically, this involves installing new packages. The specification of the new Docker image is done via Dockerfile.

Prerequisites

  • You must have a Dockerfile created on your local machine.

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Show View → Other.

    The Show View window appears.

    crs opening docker images view
  3. Enter Docker in the search field.
  4. Select Docker Images.

  5. Click Open.

    The Docker Images view appears.

    crs docker images view

  6. Click the Build Image icon.

    crs docker build image icon

    The Build a Docker Image window appears.

    crs building a docker image
  7. Name the image in the format of repo/name:version.
  8. Click Browse to locate the Dockerfile.
  9. Click Finish.

The Console view appears displaying the build process.

3.3. Managing Docker Containers

Docker containers are isolated processes that are based on Docker images. Once created, users can stop, start, pause, unpause, kill, or remove the containers as well as read their logs.

The following section describes how to manage Docker containers in CodeReady Studio.

Procedure

  1. Start CodeReady Studio.

  2. Click Window → Show View → Other.

    The Show View window appears.

    crs opening docker containers view
  3. Enter Docker into the search field.
  4. Select Docker Containers.

  5. Click Open.

    The Docker Containers view appears.

    crs docker containers view

You can start, pause, unpause, stop, kill, restart, remove, or refresh the containers by using the panel.

crs docker containers control panel