Overview

This charm installs the a basic xCAT application on either amd64 or Power architectures.
The partially installation steps follow the instructions given in the Sourceforget.net documentation:

http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/

There are suggested pre-installation and post-installation steps that the user should follow.

Pre-installation

There are two assumptions made pre-execution of the xCAT charm:

a) There is a defined domain name that will propagate in the container in which xCAT will be installed.
If a defined domain name is not available at container creation time, then the xCAT installation will
fail.

b) The default repository for xCAT is found on sourceforge.net.

If the user chooses to customize the domain name or use an alternate xCAT respository, they may alter the
installation parameters with yaml-based file re-defining two parameters (listed with their default values):

Default values:
XCAT_DOMAIN=""
XCAT_REPO="sourceforge.net"

If XCAT_DOMAIN is not altered by the user, the charm will create a container based on the default domain name of
the system, even if one does not exist.

Installation

If the user chooses to customize the either of the two variables with a custom yaml file, then the xCAT deployment
command is:

juju deploy --config override.yaml xcat

If the user chooses to go with the default values then:
juju deploy xcat

After the deployment, the user should expose the xCAT charms via:

juju expose xcat

Post-installation configuration

Due to the specific nature and use of xCAT, users will want to customize networks, images, and clients
serviced by xCAT. Thus, only part of the Quick Start installation instructions were implemented by
the charm. The user should browse the Quick Start guide for customization steps:

http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/#configure-xcat

Access to the container is achieved through:

juju ssh xcat/0

Known Limitations and Issues

When this charm attempts to deploy, and there is no host or domain entry configure in /etc/hosts, then this charm will
halt and log this failure in the juju debug-log. An override variable for the domain is provided in the install script.
The user should create a yaml file which contains override variables. Then, the charm should be deployed referencing
these override variables.

If no override domain is provided AND the provisioned container is not configured with a domain name, the charm installation
will halt with error.

Contact Information

jujusupp@us.ibm.com

APPENDIX

Online Documentation

http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/
http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/#configure-xcat
https://juju.ubuntu.com/docs/charms-config.html

Sample yaml file to override variables

xcat:
XCAT_DOMAIN: "your-domain"
XCAT_REPO: "alternate-xcat-repo"