/ICsp-Docker-OSBP

Insight Control Server Provisioning Build Plans for Docker

Primary LanguageShellApache License 2.0Apache-2.0

About ICsp

Insight Control (IC) Server Provisioning provides OS Build Plans, scripts, packages, and configuration files that are used to deploy operating systems, configure hardware, update firmware and perform scripted installations.

OS build plans are the way tasks get done in IC server provisioning. These are the items you actually run to cause actions like installing a server or updating firmware to happen. OS build plans are simply a collection of ordered steps and parameters associated with those steps that when placed together, in the proper order, can perform just about any action you require. IC server provisioning comes ready to run, with sample build plans and build plan steps that are designed to work right out of the box. These sample build plans are very important, because they demonstrate the steps needed to perform the most common deployment related operations.

The Insight Control Server Provisioning appliances does not have an OSBP to perform scripted installation of Docker Enterprise Edition. This document provides instructions and scripts to create an OSBP to deploy Docker Enterprise Edition on RHEL and is tested on Synergy Servers, ProLiant Servers and Blade Servers.

More information here: http://www8.hp.com/us/en/products/servers/management/insight-control/provisioning-server-migration.html

How to use the scripts

Scripts and files included in an OSBP in ICsp intended to install Docker EE on Proliant, Blades and Synergy using ICsp 7.6. The scripts have not been tested with later versions (since they are currently under development) but we would expect a similar behaviour. They should also work in VMs. The OS versions used are:

  • RHEL 7.2
  • SLES 12 SP1
  • Ubuntu Server 14.04

In the same way, the scripts should work with different releases of each OS version (for instance, any RHEL 7.x or SLES 12 SP2), but this hasn't been tested and we can't guarantee that it will work as expected.

RHEL

In order to create an OSBP that installs Docker EE on a RHEL7 server, we need save the provided OOTB RedHat 7.2 OSBP into a new OSBP and perform the following changes:

  • Add the following custom attributes:

    • docker_repo (mandatory): docker repository for Docker Enterprise Edition. This can be either the URL provided by Docker (external URL) or an internal URL accesible via http. When using an external URL please note that if your licence cover different Linux systems, you will need to add the ‘rhel’ folder. For instance if the URL you’ve been provided with is ‘https://storebits.docker.com/ee/linux/sub-36xxxxx3-dcc3-4ae8-b36d-06xxxxxa9/’, the custom attribute needs to be ‘https://storebits.docker.com/ee/linux/sub-36xxxxx3-dcc3-4ae8-b36d-06xxxxxa9/rhel’. If your license only covers RHEL then the provided URL should be enough. In case of doubt, please navigate to the URL through a browser to find out what the right URL is.
    • docker_version (optional): version of Docker Enterprise Edition to be installed (i.e. 17.03). If no version is specified then the latest found will be installed.
    • rhn_user (optional): Red Hat Network user (needed to register the system with Red Hat). Required if no internal_rhel_repo is specified.
    • rhn_password (optional): Red Hat Network password (needed to register the system with Red Hat). Required if no internal_rhel_repo is specified.
    • internal_rhel_repo (optional): URL pointing to an internal RHEL repository. For systems where the internet access is restricted, an internal repository can be used instead. When this custom attribute is specified, the RHN registration will be skipped. Required if no rhn_user/rhn_password are provided.
    • proxy_hostname (optional): self-explanatory
    • proxy_port (optional): self-explanatory
    • no_proxy (optional): Comma-separated list of IP addresses or server names where the proxy should not be used for
    • swarm_leader (optional): IP address to create a Swarm and where the Swarm leader will be listening from. The IP must exist in this server for the Swarm creation to succeed. If this field is set the custom attribute 'swarm_node' will be ignored. Please note that this feature is still experimental.
    • swarm_node (optional): Full command to be run to join the swarm. The commands to join as a manager or as a worker can be found in the leader deployment logs. Please note that this feature is still experimental.
    • nic_teaming (optional): the OSBP has the option to create one or more NIC teams to provide HA networking. This custom attribute defines the list of NIC teams we intend to create. Format is as follows:
     	<team name 1>, <MAC1>, <MAC2>
 	<team name 2>, <MAC3>, <MAC4>
 	<team name 3>, <MAC5>, <MAC6>
 	...

    This custom attribute can have any numbers of NIC pairs, but can also be left empty if NIC teaming is not required in the system. The IP address assigned to the NIC team will be chosen as follows:

    1. The static IP of the first NIC, if available, or
    2. The static IP of the second NIC, if available, or
    3. A DHCP provided IP if both NICs are set on DHCP.

  • Add the bash scripts for docker installation (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/rhel/install_docker_on_RHEL7.sh) and NIC teaming (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/rhel/nic_teaming_on_RHEL7.sh) at the end of the OSBP.

  • Replace the default kickstart file in the OSBP with the one provided (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/rhel/kickstart_RHEL7.ks). This new kickstart file includes the changes below:

SLES

In order to create an OSBP that installs Docker EE on a SLES 12 server, we need save the provided OOTB SLES 12 SP1 OSBP into a new OSBP and perform the following changes:

  • Add the following custom attributes:
    • docker_repo (mandatory): docker repository for Docker Enterprise Edition. This can be either the URL provided by Docker (external URL) or an internal URL accesible via http. When using an external URL please note that if your licence cover different Linux systems, you will need to add the ‘rhel’ folder. For instance if the URL you’ve been provided with is ‘https://storebits.docker.com/ee/linux/sub-36xxxxx3-dcc3-4ae8-b36d-06xxxxxa9/’, the custom attribute needs to be ‘https://storebits.docker.com/ee/linux/sub-36xxxxx3-dcc3-4ae8-b36d-06xxxxxa9/sles’. If your license only covers RHEL then the provided URL should be enough. In case of doubt, please navigate to the URL through a browser to find out what the right URL is.
    • docker_version (optional): version of Docker Enterprise Edition to be installed (i.e. 17.03). If no version is specified then the latest found will be installed.
    • internal_sles_repo (optional): for systems where the internet access is resticted, an internal repository can be used instead
    • proxy_hostname (optional): self-explanatory
    • proxy_port (optional): self-explanatory
    • no_proxy (optional): Comma-separated list of IP addresses or server names where the proxy should not be used for
    • swarm_leader (optional): IP address to create a Swarm and where the Swarm leader will be listening from. The IP must exist in this server for the Swarm creation to succeed. If this field is set the custom attribute 'swarm_node' will be ignored. Please note that this feature is still experimental.
    • swarm_node (optional): Full command to be run to join the swarm. The commands to join as a manager or as a worker can be found in the leader deployment logs. Please note that this feature is still experimental.
    • nic_teaming (optional): the OSBP has the option to create one or more NIC teams to provide HA networking. This custom attribute defines the list of NIC teams we intend to create. Format is as follows:
     	<team name 1>, <MAC1>, <MAC2>
 	<team name 2>, <MAC3>, <MAC4>
 	<team name 3>, <MAC5>, <MAC6>
 	...
    This custom attribute can have any numbers of NIC pairs, but can also be left empty if NIC teaming is not required in the system. The IP address assigned to the NIC team will be chosen as follows:
    1. The static IP of the first NIC, if available, or
    2. The static IP of the second NIC, if available, or
    3. A DHCP provided IP if both NICs are set on DHCP.
  • Add the bash scripts for docker installation (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/sles/install_docker_on_SLES12.sh) and NIC teaming (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/sles/nic_teaming_on_SLES12.sh) at the end of the OSBP.
  • Replace the default autoyast file in the OSBP with the one provided (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/sles/autoyast_SLES12.txt). This new autoyast file includes the changes below:
    • Enable the SSH service
    • Create the docker user in the system

Ubuntu

In order to create an OSBP that installs Docker EE on an Ubuntu 14.04 server, we need save the provided OOTB Ubuntu 14.04 OSBP into a new OSBP and perform the following changes:

  • Add the following custom attributes:

    • docker_repo (mandatory): docker repository for Docker Enterprise Edition. This can be either the URL provided by Docker (external URL) or an internal URL accesible via http. When using an external URL please note that if your licence cover different Linux systems, you will need to add the ‘rhel’ folder. For instance if the URL you’ve been provided with is ‘https://storebits.docker.com/ee/linux/sub-36xxxxx3-dcc3-4ae8-b36d-06xxxxxa9/’, the custom attribute needs to be ‘https://storebits.docker.com/ee/linux/sub-36xxxxx3-dcc3-4ae8-b36d-06xxxxxa9/ubuntu’. If your license only covers RHEL then the provided URL should be enough. In case of doubt, please navigate to the URL through a browser to find out what the right URL is.
    • docker_version (optional): version of Docker Enterprise Edition to be installed (i.e. 17.03). If no version is specified then the latest found will be installed.
    • internal_ubuntu_repo (optional): for systems where the internet access is resticted, an internal repository can be used instead of the default server defined in the /etc/apt/sources.list file. When an internal repository is specified, a new file called /etc/apt/sources.list.d/internal.list is created and the old /etc/apt/sources.list is renamed to /etc/apt/sources.list.old.
    • proxy_hostname (optional): self-explanatory
    • proxy_port (optional): self-explanatory
    • no_proxy (optional): Comma-separated list of IP addresses or server names where the proxy should not be used for
    • swarm_leader (optional): IP address to create a Swarm and where the Swarm leader will be listening from. The IP must exist in this server for the Swarm creation to succeed. If this field is set the custom attribute 'swarm_node' will be ignored. Please note that this feature is still experimental.
    • swarm_node (optional): Full command to be run to join the swarm. The commands to join as a manager or as a worker can be found in the leader deployment logs. Please note that this feature is still experimental.
    • nic_bonds (optional): the OSBP has the option to create one or more NIC bonds to provide HA networking. This custom attribute defines the list of bonds we intend to create. Format is as follows:
     	<bond name 1>, <MAC1>, <MAC2>
 	<bond name 2>, <MAC3>, <MAC4>
 	<bond name 3>, <MAC5>, <MAC6>
 	...

    This custom attribute can have any number of NIC pairs, but can also be left empty if bonding is not required in the system. The IP address assigned to the bond will be static and will be taken from the first NIC. If the first NIC does not have an assigned IP, then the IP of the second NIC will be used instead.

  • Add the bash scripts for docker installation (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/ubuntu/install_docker_on_Ubuntu_14.04.sh) and bonding (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/ubuntu/bonding_on_Ubuntu_14.04.sh) at the end of the OSBP.

  • Replace the default preseed file in the OSBP with the one provided (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/ubuntu/preseed_Ubuntu_14.04.cfg). This new preseed file includes the changes below:

    • Disable the default route (this makes the installation stop)
    • Create the docker user in the system

  • Add the sources.list file (https://github.com/HewlettPackard/ICsp-Docker-OSBP/blob/master/ubuntu/sources.list) as a configuration file in ICsp and add an extra step in the OSBP to replace the original sources.list just before running the Docker script (should be step 25).

Accessing the systems

You should be able to login via SSH to the brand new system using the 'docker' account and the password 'ChangeMe123!'. You can then switch to root if required using the same password, but you won’t be allowed to connect directly with root via SSH. It is highly recommended that you change both passwords as soon as you log in for the first time.

Note: the docker user is not part of the sudoers by default, so you won’t be able to run privileged commands or to switch to root by using the sudo command. You should instead switch to root by using the su command (with either "su -" or "su - root") and then entering the root password.

More information

Disclaimer

As per section 7 of the Apache 2.0 license, this software is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND. In addition to this, there is no plan to keep maintaining this software on a regular basis. However, if you encounter a problem running the scripts, we would be grateful if you could let us know by creating a new issue in GitHub or by contacting us directly. We'll do our best to address your feedback on a best-effort basis.