Release Notes and Known Issues
Highlighted features and identified problems in Red Hat Container Development Kit 2.4
Abstract
Chapter 1. Introducing Red Hat Container Development Kit
Red Hat Container Development Kit is a platform for developing containerized applications — it is a set of tools that enables developers to quickly and easily set up an environment for developing and testing containerized applications on the Red Hat Enterprise Linux platform.
- Container Development Kit provides a personal Container Development Environment you can install on your own laptop, desktop, or server system. The Container Development Environment is provided in the form of a Red Hat Enterprise Linux virtual machine. The Container Development Environment itself can also be installed in a virtual machine.
- Container Development Kit includes the same container-development and run-time tools used to create and deploy containers for large data centers.
- Container Development Kit offers an easy installation method that results in virtual machines created from pre-configured Vagrant boxes and Vagrantfiles running on your local system.
- Container Development Kit is available for Microsoft Windows, Mac OS X, and Linux operating systems, thus allowing developers to use their favorite platform while producing applications ready to be deployed in the Red Hat Enterprise Linux ecosystem.
Container Development Kit is a part of the Red Hat Developers program, which provides tools, resources, and support for developers who wish to utilize Red Hat solutions and products to create applications, both locally and in the cloud. For additional information and to register to become a part of the program, visit developers.redhat.com.
1.1. Understanding Container Development Kit Documentation
- The Red Hat Container Development Kit 2.4 Release Notes and Known Issues contains information about the current release of the product as well as a list of known problems that users may encounter when using it.
- The Red Hat Container Development Kit 2.4 Installation Guide contains instructions for installing the Container Development Environment provided by Red Hat Container Development Kit on your chosen system.
- The Red Hat Container Development Kit 2.4 Getting Started Guide contains instructions on how to start using the Container Development Environment to develop Red Hat Enterprise Linux-based containers using tools and services such as OpenShift Container Platform, Docker, Eclipse, and various command-line tools.
- Report issues with Red Hat Container Development Kit or request new features using the CDK project at https://issues.jboss.org/projects/CDK.
Chapter 2. Release Notes
This section documents the most important features and bug fixes in the Red Hat Container Development Kit 2.4 product.
2.1. Component Versions
Red Hat Container Development Kit 2.4 is shipped with the following versions of the main components:
Component | Version |
---|---|
Docker | 1.12.5 |
Docker API | 1.24 |
Kubernetes | 1.4.0 |
OpenShift Container Platform | 3.4 |
2.2. VirtualBox Compatibility
Red Hat Container Development Kit 2.4 has been tested with VirtualBox 5.0.26 and higher, but it is known to not work correctly with VirtualBox 5.1.x. If you intend to use VirtualBox as your virtualization provider, and you already have VirtualBox 5.1.x installed, downgrade your installation to VirtualBox 5.0.26.
2.3. Vagrant Compatibility Matrix
The Container Development Environment provided by Container Development Kit is delivered in the form of a virtual machine that is administered by Vagrant. Not all versions of Vagrant work correctly with the Container Development Environment on all supported platforms. The following table shows version requirements for Vagrant based on the platform and hypervisor used.
Vagrant version | ||
1.7.4 | 1.8.1 | |
Microsoft Windows with VirtualBox | ✓ | ✓ |
Microsoft Windows with Hyper-V | ✘ | ✓ |
macOS with VirtualBox | ✓ | ✓ |
Red Hat Enterprise Linux with libvirt | ✓ | ✓ |
2.4. New Features
This section documents changes to Red Hat Container Development Kit 2.4.
2.4.1. Relative Paths Are Now Supported
Relative pathnames are now supported, so the full path does not need to be specified with the --path option. For example, the following should now work:
C:\> mkdir test C:\> vagrant.exe service-manager install-cli openshift --path test
2.4.2. Updated Openshift Container Platform
Container Development Kit 2.4 now includes OpenShift Container Platform 3.4.0.40.
2.4.3. Red Hat Container Development Kit 3.0 beta now available
Red Hat Container Development Kit is available as Red Hat Container Development Kit 3.0 beta. No technical support is provided for this beta version.
Chapter 3. Known Issues
This section describes issues that users of Red Hat Container Development Kit 2.4 may encounter, as well as possible workarounds for these issues.
3.1. General Issues
Issues affecting all supported platforms.
3.1.1. Vagrantfile
for Individual Users is Ignored When Using a Proxy
A Vagrantfile
for a specific user does not use the supplied username and password if configured to use a proxy. The following file created in ~/.vagrant.d/Vagrantfile
does not work as expected:
Vagrant.configure(2) do |config| config.registration.username = "actual_username" config.registration.password = "actual_password" end
Specifying the username and password by using environment variables has the same result:
~]$ export PROXY="proxy_addr" ~]$ export PROXY_USER="actual_user" ~]$ export PROXY_PASSWORD="actual_password"
The user will be prompted interactively for the username and password in either case.
If no proxy is set, Container Development Kit uses the username and password supplied in ~/.vagrant.d/Vagrantfile
.
3.2. Issues on Microsoft Windows
This section describes issues that only affect users on a Microsoft Windows host system.
3.2.1. vagrant service-manager
Output Shows Paths With Cygwin
Syntax
The output from vagrant service-manager
does not follow Microsoft Windows CMD.exe syntax. The path given does not work outside of Cygwin
. The following error is shown:
C:\DevelopmentSuite\cdk\componenets\rhel\rhel-ose> mkdir C:\tmp C:\DevelopmentSuite\cdk\componenets\rhel\rhel-ose> vagrant service-manager install-cli openshift --path C:\tmp # Binary now available at /cygdrive/c/tmp # run binary as: # oc <command> export PATH=/cygdrive/c/tmp:$PATH # run following command to configure your shell: # eval "$(VAGRANT_NO_COLOR=1 vagrant service-manager install-cli openshift --path /cygdrive/c/tmp | tr -d '\r')"
The correct syntax for Microsoft Windows paths includes the drive letter and path available in Microsoft Windows outside of Cygwin
, in this case C:\tmp
3.2.2. Using Cygwin
Syntax for a Path Causes an Error
The vagrant service-manager install-cli
command with --path
option does not work when using Cygwin
syntax on both Microsoft Windows 7 and 10. The following error is shown:
~] $ vagrant.exe service-manager install-cli openshift --path /cygdrive/c/test undefined local variable or method `dir_name' for #<VagrantPlugins::ServiceManager::Installer:0x492b130>
To workaround this issue, use the CMD.exe syntax with drive letter for the path, like vagrant.exe service-manager install-cli openshift --path c:/test
Chapter 4. Additional Resources
- See the Red Hat Container Development Kit 2.4 Installation Guide for installation instructions for all supported platforms (Linux, macOS, Windows).
- See the Troubleshooting chapter of the Red Hat Container Development Kit 2.4 Installation Guide for additional information about uninstallation issues.
- See the Red Hat Container Development Kit 2.4 Getting Started Guide for an overview of Container Development Kit features and for an introduction into the use of the Docker service and the OpenShift Container Platform platform.
- Report issues with Red Hat Container Development Kit or request new features using the CDK project at https://issues.jboss.org/projects/CDK.