Merge lp:~kwmonroe/charms/trusty/xcat/deprecate into lp:~ibmcharmers/charms/trusty/xcat/trunk

[Kevin W Monroe]

Please merge this deprecation notice since this charm should be replaced by ibm-xcat.

[Venkatesh (n-venkatesh)]

review: Approve

=== modified file 'README.md'
--- README.md	2015-10-09 05:38:59 +0000
+++ README.md	2016-03-04 18:31:14 +0000
@@ -1,71 +1,3 @@
-# Overview
-
-This charm installs the basic xCAT application on either amd64 or Power architectures.
-The initial installation steps follow the instructions given in the sourceforge [link.][installation-steps]
-
-There are suggested pre-installation and post-installation steps that the user should follow.
-
-Ensure to run this charm on release that has xCAT support. The minimum release expected is trusty.
-
-# 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 repository, they may alter the installation parameters found within [config.yaml] which are having default values as below
-
-	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 if it exists. If not, the user will have to set the XCAT_DOMAIN name. It is recommended to use default value for XCAT_REPO="sourceforge.net".
-
-# 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 charm via:
-
-	juju expose xcat
-
-# Post-installation configuration
-
-Due to the specific nature and use of xCAT, user will have 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 in the [link][installation-steps] 
-
-# configure-xcat
-
-Access to the container is achieved as in the example below. For more information refer xcat configuration [link][config-steps].
-
-	juju ssh xcat/0
-
-# Known Limitations and Issues
-
-When this charm attempts to deploy, and there is no host or domain entry configuration 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 or by setting the XCAT_DOMAIN name value.
-
-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
-
-For issues with this charm, please contact IBM Juju Support Team <[e-mail]>
-
-
-<!-- Links -->
-
-[installation-steps]: http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/
-
-[config-steps]: http://sourceforge.net/p/xcat/wiki/Ubuntu_Quick_Start/#configure-xcat
+# DEPRECATED
+
+This charm is no longer being maintained. Please use `ibm-xcat` instead.

=== modified file 'metadata.yaml'
--- metadata.yaml	2015-12-04 07:01:21 +0000
+++ metadata.yaml	2016-03-04 18:31:14 +0000
@@ -1,7 +1,8 @@
 name: xcat
-summary: This charm installs base xCAT with no configuration.
+summary: xCAT (deprecated, use ibm-db2)
 maintainer: Juju Support Team <[e-mail]>
-description: Installation of xCAT from packages available on Sourceforge.net.  Performs base install without additional network or image customization.  Additional customization is left to the admin.
+description: |
+  DEPRECATED: please use ibm-xcat instead.
 tags:
   - ibm
   - ops