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

[Kevin W Monroe]

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

[Suchitra Venugopal (suchvenu)]

review: Approve

=== modified file 'README.md'
--- README.md	2015-08-18 06:30:00 +0000
+++ README.md	2016-02-13 18:13:12 +0000
@@ -1,153 +1,3 @@
-Charm for IBM DB2 10.5
-
-Overview
---------
-
-IBM DB2
-
-IBM DB2 Express Server Edition is an entry level database system designed
-for transaction processing and handling complex query workloads.
-DB2 Server is provided as part of this charm.
-
-For details on DB2, as well as information on purchasing, please visit:
-[Product Page][product-page]
-There is product information there and contact information to obtain a
-quote and arrange the DB2 packages provided by IBM or you can purchase
-and download directly there.
-
-More information available at the [IBM Knowledge Center][ibm-db2]
-
-Usage
-------
-To install DB2, you need to download the packages for Ubuntu and create a
-apt repository. To acquire and download DB2, follow instructions available at the  [Product Page][product-page]
-The Part Number used is CIXV0ML for X86-64 platform and that for Power is CN3YQML .
-
-To install the downloaded binaries you must agree to the IBM license. You can view the full license for DB2 by visiting the [Software license agreements search website][license-info]. Search for "DB2 Enterprise Server Edition 10.5.0.5" and choose the license that applies to the version you are using.
-
-#Creating the repositories
-Run steps below with admin access
-
-Install needed packages
-    apt-get install dpkg-dev apache2
-
-Create the repository on apache server
-Under your apache repository directory
-    cd <apache-repository-directory>
-    mkdir DB2
-Place the downloaded tar.gz file in the above directory
-
-Configure apache server to allow access to the repository
-Configure config.yaml with the repository url
-db2_url: "http://<server-name>/<REPOSITORY_DIR>/DB2"
-
-
-Verify repository is set correctly otherwise charm might throw errors.
-
- Deploy
--------
-To deploy DB2 charm run the following command:
-
-For that either use an existing machine, or create a new machine using
-
-    juju add-machine
-    juju deploy --to <machine number> --repository=<path_to_charms_folder> local:trusty/db2
-
-At this point DB2 install will wait for you to accept the License. To install the downloaded binaries you must agree to the IBM license.  The license file(s) can be found in the product binaries you downloaded.
-
-If you agree to the license, run the following command (without accepting License DB2 cannot be installed):
-
-If the URL and package is configured in the config.yaml:
-
-    juju set db2 accept-ibm-db2-license=True
-If not,
-
-    juju set db2 accept-ibm-db2-license=True db2_url=<DB2 URL> db2_package_name=<DB2 Package name>
-
-Juju deploy command will install db2 and will expose the hostname, portnumber, db2 instance and userid to the users. 
-Setting the accept-ibm-db2-license to False will uninstall the product. 
-
-    juju set db2 accept-ibm-db2-license=False
-
-If the user wants to set a different file path used to create databases and logs it can be set using the config value dftdbpath. Use the following command to set it
-
-    juju set db2 dftdbpath=<new-path-to-set>
-
-
-Configuration
--------------
-See config.yaml file for more information.
-
- `db2_url`              : The web server URL from which IBM DB2 packages can be downloaded.
-
-  `db2_package_name`      : The db2 package name to be installed. This name can be got from the b2_url path in the repository. If not set, it is assigned the value "DB2_Svr_10.5.0.3_Linux_x86-64.tar.gz" for x86_64 based machine.
-
- `accept-ibm-db2-license`: True to accept license Before you can use or install IBM DB2, you must accept the terms of International License Agreement for Non-Warranted Programs and additional license information. Please read the license agreement carefully. The license file(s) can be found under the server/db2/license directory after downloading and extracting IBM DB2 there. Set the value of accept-ibm-db2-license to True if you agree to IBM DB2 license.
-
-  `sha`                   : Checksum value to check integrity of IBM DB2 package. The Charm uses sha1sum to check the integrity. If empty, it does not carry out the integrity check.Cryptographic value should be altered by the user only when the package name is changed. Else it should not be altered.The command to find the checksum is sha1sum <Package Name> | cut -d" " -f1.
-
-  `dftdbpath`             : This parameter contains the default file path used to create databases under the database manager.  If no path is specified when a database is created, the database is created under the path specified by the dftdbpath parameter.
-  
-Memory and Disk Requirements
-----------------------------
-Memory requirements are affected by the size and complexity of your database system, the extent of database activity, and the number of clients accessing your system. At a minimum, a DB2 database system requires 256 MB of RAM. For a system running just a DB2 product and the DB2 GUI tools, a minimum of 512 MB of RAM is required. However, 1 GB of RAM is recommended for improved performance.
-
-On Linux and UNIX operating systems, 2 GB of free space in the /tmp directory is recommended. On Linux and UNIX operating systems, you must install your DB2 product in an empty directory. If the directory that you have specified as the install path contains subdirectories or files, your DB2 installation might fail. More information on this can be found in [db2-memory-disk-requirement]
-
-Enabling BLU acceleration for DB2 Advanced Enterprise Server Edition
----------------------------------------------------------------------
-The same DB2 charm(DB2 Enterprise Server Edition) can be extended to enable the BLU acceleration(DB2 Advanced Enterprise Server Edition with BLU acceletaion)  by following the below section. The DB2 charm has to be deployed first and then few settings needs to be done to enable the BLU feature. 
-
-To upgrade DB2 Enterprise Server Edition (DB2 ESE) to DB2 Advanced Enterprise Server Edition(DB2 AESE) the user need to accept the license for the same. Run the following command for accepting the AESE license which the user procure when he buy the product. 
-
-    db2licm -a </path/to/license/file/db2aese_u.lic>
-    
-db2licm -l command will show the license details once you apply the license. 
-Now to enable the BLU feature the DB2_WORKLOAD registry variable has to be set to ANALYTICS and then the DB has to be restarted. The following commands will help the user for this.
-
-    db2set DB2_WORKLOAD=ANALYTICS
-    db2stop force
-    db2start
-    
-To test that DB2 AESE with BLU acceleration is enabled run the following command:
-
-    db2 get db cfg | grep DFT_TABLE_ORG
-    
-The output Default table organization              (DFT_TABLE_ORG) = COLUMN confirms that the DB2 AESE with BLU is enabled. If the pre requisites for DB2 for AESE is not set (accepting the proper license and setting the registry varaible DB2_WORKLOAD) the above command would return Default table organization              (DFT_TABLE_ORG) = ROW.  Column-organized tables store each column on a separate set of pages on disk. Organizing data by column on disk reduces the amount of I/O needed for processing queries because only columns that are referenced in a query need to be accessed. 
-
-Once this is set all the tables created will be by default COLUMN organised where as without BLU acceleration the tables will be ROW organised. Also without proper license we cannot create COLUMN organised tables. Once we enable COLUMN organised tables, we can create either ROW enabled or COLUMN enabled tables using the option ORGANIZE BY COLUMN or ORGANIZE BY ROW while creating the tables.
-
-The following command will convert the ROW organised tables to COLUMN organised if the proper license is accepted. Without having valid license the following command will error out.  
-   
-    db2convert -d 	<db_name>
-    
-More details on BLU feature can be found in the link [db2-BLU-acceleration]
-
-IBM DB2 Information
--------------------
-
-(1) General Information
-Information on IBM DB2 available at the [DB2 Knowledgecenter][db2-knowledgecenter]
-
-(2) Download Information
-Information on procuring DB2 product is available at the [Passport Advantage Site][passport-db2]
-
-(3) Contact Information
-For issues with this charm, please contact <[e-mail]>
-
-
-<!-- Links -->
-
-[product-page]: http://www-03.ibm.com/software/products/en/db2-express-server-edition
-
-[ibm-db2]: http://www-01.ibm.com/support/knowledgecenter/SSEPGG_10.5.0/com.ibm.db2.luw.kc.doc/welcome.html
-
-[license-info]: http://www-03.ibm.com/software/sla/sladb.nsf/search
-
-[passport-db2]: http://www-01.ibm.com/software/passportadvantage/
-
-[db2-knowledgecenter]: http://www-01.ibm.com/support/knowledgecenter/SSEPGG_10.5.0/com.ibm.db2.luw.kc.doc/welcome.html
-
-[db2-memory-disk-requirement]: http://www-01.ibm.com/support/knowledgecenter/SSEPGG_9.7.0/com.ibm.db2.luw.qb.server.doc/doc/r0008877.html?cp=SSEPGG_9.7.0%2F2-0-2-0-4
-
-[db2-BLU-acceleration]: http://www.ibm.com/developerworks/data/library/techarticle/dm-1309db2bluaccel/
+# DEPRECATED
+
+This charm is no longer being maintained. Please use `ibm-db2` instead.

=== modified file 'metadata.yaml'
--- metadata.yaml	2015-07-22 09:37:07 +0000
+++ metadata.yaml	2016-02-13 18:13:12 +0000
@@ -1,14 +1,12 @@
 name: db2
-summary: IBM DB2
+summary: IBM DB2 (deprecated, use ibm-db2)
 maintainer: IBM Juju Support Team <[e-mail]>
 description: |
-  IBM DB2 Express Server Edition is an entry level database system designed for transaction
-  processing and handling complex query workloads. 
+  DEPRECATED: please use ibm-db2 instead.
 tags:
   - misc
-  - database 
+  - database
 subordinate: false
 provides:
  db:
     interface: db2
-