← Back to branch summary

~kwmonroe/charms/trusty/xcat/deprecate

« back to all changes in this revision

Viewing changes to charms/trusty/xcat/README

  • Committer: jshieh at ibm
  • Date: 2015-02-26 15:15:34 UTC
  • Revision ID: jshieh@us.ibm.com-20150226151534-b7r3v9doe7lippjl
Updated README, config.yaml, and install script based on code review comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
charms/trusty/xcat/README
1
1
# Overview
2
 
This charm installs the base xCAT application on either amd64 or Power architectures.  The installation steps follow
3
 
the instructions given in the Sourceforget.net documentation:
 
2
This charm installs the a basic xCAT application on either amd64 or Power architectures.
 
3
The partially installation steps follow the instructions given in the Sourceforget.net documentation:
4
4
 
5
5
http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/
6
6
 
7
 
This documentation can help users customize their system post-install.
8
 
# Usage
9
 
 
10
 
Step by step instructions on using the charm:
11
 
 
 
7
There are suggested pre-installation and post-installation steps that the user should follow.
 
8
 
 
9
# Pre-installation
 
10
 
 
11
There are two assumptions made pre-execution of the xCAT charm:
 
12
 
 
13
a) There is a defined domain name that will propagate in the container in which xCAT will be installed.
 
14
If a defined domain name is not avialable at container creation time, then the xCAT installation will
 
15
fail.
 
16
 
 
17
b) The default repository for xCAT is found on sourceforge.net.
 
18
 
 
19
If the user chooses to customize the domain name or use an alternate xCAT respository, they may alter the
 
20
installation parameters with yaml-based file re-defining two parameters (listed with their default values):
 
21
 
 
22
Default values:
 
23
XCAT_DOMAIN=""
 
24
XCAT_REPO="sourceforge.net"
 
25
 
 
26
If XCAT_DOMAIN is not altered by the user, the charm will create a container based on the default domain name of
 
27
the system, even if one does not exist.
 
28
 
 
29
# Installation
 
30
 
 
31
If the user chooses to customize the either of the two variables with a custom yaml file, then the xCAT deployment
 
32
command is:
 
33
 
 
34
    juju deploy --config override.yaml xcat
 
35
 
 
36
If the user chooses to go with the default values then:
12
37
    juju deploy xcat
 
38
 
 
39
After the deployment, the user should expose the xCAT chamr via:
 
40
 
13
41
    juju expose xcat
 
42
 
 
43
# Post-installation configuration
 
44
 
 
45
Due to the specific nature and use of xCAT, users will want to customize networks, images, and clients
 
46
serviced by xCAT.  Thus, only part of the Quick Start installation instructions were implemented by
 
47
the charm. The user should browse the Quick Start guide for customization steps: 
 
48
 
 
49
http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/#configure-xcat
 
50
 
 
51
Access to the container is achieved through:
 
52
 
14
53
    juju ssh xcat/0
15
54
 
16
 
The user can then browse to http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/
17
 
in order to further customize the charm instance.  Note that this charm only does
18
 
the bare essential installation of the charm.  The user must then customize the network
19
 
and host images to their specific needs.
20
 
 
21
 
## Known Limitations and Issues
 
55
# Known Limitations and Issues
22
56
 
23
57
When this charm attempts to deploy, and there is no host or domain entry configure in /etc/hosts, then this charm will
24
58
halt and log this failure in the juju debug-log.  An override variable for the domain is provided in the install script.
25
 
If the user fills in a value for OVERRIDE_DOMAIN within the install script, then if no domain name is found the user-provided
26
 
domain will be configured in /etc/hosts and the charm installation will go forward.
27
 
 
28
 
# Configuration
29
 
 
30
 
This charm does not provide post-installation configurtion after the base install of xCAT.  Refere to the Quick Start
31
 
document referenced earlier for suggested post-install configuration steps.
 
59
The user should create a yaml file which contains override variables.  Then, the charm should be deployed referencing 
 
60
these override variables.
 
61
 
 
62
If no override domain is provided AND the provisioned container is not configured with a domain name, the charm installation
 
63
will halt with error.
 
64
 
32
65
 
33
66
# Contact Information
34
 
 
35
67
jshieh@us.ibm.com
36
68
 
 
69
# APPENDIX
 
70
 
 
71
# Online Documentation
 
72
 
 
73
http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/
 
74
http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/#configure-xcat
 
75
https://juju.ubuntu.com/docs/charms-config.html
 
76
 
 
77
 
 
78
# Sample yaml file to override variables
 
79
xcat:
 
80
  XCAT_DOMAIN: "your-domain"
 
81
  XCAT_REPO: "alternate-xcat-repo"
 
82