Creating a remote Liberty server in a Docker container by using developer tools

You can use WebSphere® Developer Tools to create a reference to a Liberty server that is running in a Docker container on a remote host. You can use this reference to handle your server requests from the workbench.

1. In the workbench, open the Servers view by clicking the Servers tab.
   Tip: If the Servers view is not visible, select Window > Show view > Other... and type Server in the filter text. Then, select Servers.
2. Right-click within the Servers view and select New > Server.
3. To select your server type, select IBM > Liberty Server.
4. Enter the remote host name in the Server's host name field.
5. Click Next.
   Note: Ensure that the Liberty runtime environment has the same set of features as the selected Liberty docker image. Also, ensure that they are configured to use the same level of the Java™ runtime environment (JRE). The Liberty runtime environment target runtime is used in the development environment. A mismatch between the local system runtime and the JRE used in the Liberty docker image can cause problems from configuration errors to application publishing issues.
6. If the tools prompt you to install WebSphere Application Server Liberty, either because it is not installed or because you need to input the directory where it is installed, complete one of the following options. Otherwise, skip this step.

   You need Liberty to be installed so that you can create a workbench reference to a Liberty server in a Docker container on a remote host.

   If you previously installed Liberty, complete the following steps to select the directory where you installed it:

   1. Select Choose an existing installation.
   2. In the Path field, type or browse for the directory where you installed the WebSphere Application Server Liberty.
   3. On the Liberty Runtime Environment page, click Next.

      The application-serving environment is selected. Skip the rest of this step.

   If you want to install Liberty from an archive file that was previously downloaded, complete the following steps:

   1. Select Install from an archive or repository, and click Next.
   2. In the Destination field, type or browse to the directory where you want to install the Liberty runtime environment.

      If you type a path that does not exist, then a folder for that path is created automatically at the end of the procedure when you click Finish.

   3. Select Install a new runtime environment from an archive.
   4. In the Path field, either type or browse to the archive file on the local file system, and click Next.
   5. In the Install Add-ons page, click Install or Install Pending to make your selection of add-on archive files that you want to install on the Liberty runtime environment.

      You can install an add-on archive file from your local file system, download an add-on archive file, or use a combination of both when you install multiple add-on archive files.

      This download site includes add-ons that you can select from the Liberty Repository, such as runtime features, samples, or open source integration.

      If you want to install add-on archive files from your local file system, complete the following steps:

      1. Click Add Archive.
      2. In the Add-on archive field, type or browse to the add-on archive file on the local file system.
      3. Click OK.

      If you have more add-on archive files to install from your local file system, repeat this procedure until you are done.

      If you want to install add-on files from a custom repository, complete the following steps:

      1. To add the repository, click Configure Repositories.
      2. Click New....

      The files are then added to the list of add-on files.

      After you complete your selection in the Install Add-ons page, click Next.

   6. In the License Acceptance page, if you accept the license terms, select I accept the terms of all the license agreements, and then click Next.

   If you want to download and install the no-charge developer edition for Liberty, complete the following steps:

   1. Select Install from an archive or repository, and click Next.
   2. In the Destination field, type or browse to the directory where you want to install the Liberty runtime environment.

      If you type a path that does not exist, then a folder for that path is created automatically at the end of the main procedure when you click Finish.

   3. Select Download and install a new runtime environment from ibm.com, choose a runtime environment version, and then click Next.
   4. In the Install Add-ons page, click Install or Install Pending to make your selection of add-on archive files that you want to install on the Liberty runtime environment.
      You can install add-on archive files by one of the following methods:

      • From your local file system
      • By downloading files
      • By using a combination of both when you install multiple add-on archive files

      If you want to install add-on archive files from your local file system, complete the following steps:

      1. Click Add Archive.
      2. In the Add-on archive field, type or browse to the add-on archive file on the local file system.
      3. Click OK.

      If you have more add-on archive files to install from your local file system, repeat this procedure until you are done.

      If you want to install add-on files from a custom repository, complete the following steps:

      1. To add the repository, click Configure Repositories.
      2. Click New....

      The files are then added to the list of add-on files.

      After you complete your selection in the Install Add-ons page, click Next.

   5. In the License Acceptance page, if you accept the license terms, select I accept the terms of all the license agreements then click Next.
7. On the Remote Server Settings page, select Server in a Docker container.
8. Select the operating system for your remote server
   Restriction: The tools do not support operating system authentication for Windows operating system.
9. Select a method to access the remote host, enter the log-in information, and click Next.
10. On the New Server in a Docker Container page, select your Docker container from the Container name menu.
    Tip: If you do not see your Docker container in the Container name menu, click Refresh to refresh the list.
11. Enter the Liberty server security credentials.
    Your values for the User name and Password fields must correspond to a user that is defined in a user registry that has an administrator role. If the tools cannot find a basic user registry that defines the specified user, the tools display the Security Verification window. If the tools display the Security Verification window, complete one of the following options:

    • Select Create to add a basic user registry that defines a user with your values and an administrator role.
    • Select Proceed to proceed if the user is defined in another user registry type.
    • Select Cancel to make changes to the User name and Password that you entered.
12. Enter the value for the Secure port field with the HTTPS port that is specified in the server configuration.
    Tip: The default HTTPS port number is 9443.
13. Click Finish.