Skip to content

Latest commit

 

History

History
401 lines (276 loc) · 10.6 KB

README.md

File metadata and controls

401 lines (276 loc) · 10.6 KB
Raw

Command Central server setup

This project automates Command Central initial setup:

  • Download bootstrap installer for your OS from SDC
  • Run bootstrap installer
  • Configure HTTP/S proxy
  • Register master repositories
  • Upload license keys
  • Upload product and fix images
  • Create mirror repositories

You can use this project to maintain your Command Central:

  • Pull the latest fixes/products into mirror repositories
  • Update Command Central to the latest patch level
  • Upgrade Command Central to a new release
  • Start/stop/restart Command Central
  • Check jobs and logs

You can also build customized Command Central Docker image to launch containers using your favourite Docker orchestrator.

Requirements

To get started clone or fork this project (you will need to customize it) and run git submodule initialization procedure to pull antcc library

git clone https://github.com/SoftwareAG/sagdevops-cc-server
cd sagdevops-cc-server
git submodule init
git submodule update

Verify that your antcc folder is not empty.

Quick Start

Bootstrap the latest version of Command Central server:

ant boot -Daccept.license=true

IMPORTANT: By setting accept.license=true property you are accepting End User License Agreement

The command will download the bootstrap installer for your operating system and run it for you. This may take up to 30 minutes. Then the installer is executed and the output would look like this:

[exec] ####
[exec] #### You can logon to Command Central Web UI as Administrator/manage
[exec] ####
[exec] ####     https://localhost:8091/cce/web
[exec] ####
[exec] #### You can also explore Command Central CLI commands by running from a NEW shell:
[exec] ####
[exec] ####     sagcc --help
[exec] ####

Open Command Central Web UI using the URL printed above and login using the specified credentials.

Verify client connectivity to the Command Central server:

ant waitcc

The bootstrap process is complete.

Customizing bootstrap process

You can customize configuration for the bootstrap process.

Edit bootstrap/default.properties and uncomment the following property to accept the license agreement:

accept.license=true

Review and modify any other properties as needed.

Run bootstrap process using the default properties file:

ant boot

NOTE: most of the properties are applicable only for a new boostrap session. If you already bootstraped Command Central they will NOT apply for this installation. You can re-bootstrap Command Central by running this command:

ant uninstall boot

The downloaded bootstrap installer file will be reused (not downloaded again).

Customizing Command Central configuration

Configure proxy connection

If you have direct connection to the Internet you can skip this step.

If you have a proxy server update environments/default/env.properties with your HTTP/S proxy configuration:

proxy.http.host=YOURPROXYHOST
proxy.http.port=8080
proxy.http.nonproxyhosts=localhost|.my.domain

Then run:

ant proxy

Register master repositories for products and fixes

If this Command Central does not have access to the Internet you can skip this step.

IMPORTANT: Your gateway or development Command Central should have access to the Internet.

To register master repositories Command Central needs your Empower credentials with permissions to download products and fixes.

When you run:

ant masters

Command Central will check environments/default/env.properties first and if the credentials are not configured there it will ask you to provide them. It then will store them in the env.properties file for later use.

empower.username=YOUR_EMPOWER_USERNAME
empower.password=YOUR_PASSWORD

Verify successful master repositories setup:

ant test

Add license keys

If you can skip this step if you plan on adding your license keys for each individual project, however it is recommended to add all your license keys now.

Place your SAG products license key .xml files under ./licenses/ folder.

You can customize the location of the licenses folder in environments/default/env.properties by setting this property:

licenses.dir=/path/to/licenses/

IMPORTANT: the structure of the licenses.dir folder must be the following:

licenses\
   any\
      license-key-for-any-OS.txt
      license-key-for-any-OS.xml
      ...
   w64\
      any-windows-license-key.xml
      ...
   lnxamd64\
      any-linux-license-key.xml
      ...
   ...

Run this command to import license files:

ant licenses

You can run this command again any time to add upload new license keys.

Add product and fix images

You can skip this step if you're planning to use only master and mirror repositories.

Use of image repositories is discouraged.

If you want to upload SAG Installer images to Command Central place the image .zip files under ./images/products folder.

If you want to upload SAG Update Manager images place the image .zip files under ./images/fixes folder.

You can customize the location of the images folder in environments/default/env.properties by setting this property:

images.dir=/path/to/images/

IMPORTANT: the structure of the images.dir folder must be the following:

products\
    my-9.12-products-lnxamd64.zip
    my-9.12-products-w64.zip
fixes\
    my-9.12-fixes.zip
    my-9.10-fixes.zip

Run this command to upload image files:

ant images

You can run this command again any time to add upload new images.

Create mirror repositories

You should create mirror repositories to improve provisioning performance.

NOTE: this process may take a long time and requires up to 10GB of space on average per release if you mirror all products.

You can customize which release and which products/fixes to mirror using environments/default/env.properties by setting this property:

release=9.x
mirror.products=productId1,productId2,...

TIP: To find out product ids, open Command Central Web UI, webMethods-${release} repository content view and tick Show ID Column checkbox in the gear menu.

To start mirrors create or update process run:

ant mirrors

NOTE: fix mirror will download fixes only for the products in your product mirror repository.

You can run this command again any time to pull the latest products/fixes from the upstream repos.

Commit your changes to version control system

IMPORTANT: To ensure your entire customized setup runs cleanly perform end-to-end run:

Adjust 'up' target in build.xml with the targets that are applicable to your setup and run:

ant uninstall boot up test

The succesful test run will end with something like this:

[au:antunit] Environment configuration: environments/test/env.properties
[au:antunit] ------------- ---------------- ---------------
[au:antunit] Target: test-repos-master-prods took 1.103 sec
[au:antunit] Target: test-repos-master-fixes took 1.092 sec
[au:antunit] Target: test-repos-master-fixes-listing took 10.117 sec
[au:antunit] Target: test-repos-master-prods-listing took 48.337 sec

BUILD SUCCESSFUL
Total time: 41 minutes 27 seconds

Commit your changes to your target version control system, e.g. forked project on github or internal git repo.

Now you can pull and run this project on any other host to perform identical fully automated setup of your customized Command Central server:

ant boot up

Cleanup

To uninstall Command Central run:

ant uninstall

Building Docker image with customized Command Central server

You can package all your customizations done above into a Docker image so that you can quickly launch new instances of Command Central for each of your CD stages or for CI testing.

Requirements

Before you start ensure you have installed Docker including docker-compose tool.

There are no other requirements. You don't even have to have local Java or Apache Ant.

Building Docker image

By default the image build runs only 'masters licenses' targets. You can adjust that by modifying RUN command in the main Dockerfile.

IMPORTANT: to build Docker image all license and image files MUST be in default location folders under this project. Docker sends all these files as build context. Docker cannot send files ouside of the current folder!

NOTE: including product or fix image files and creating mirror repositories will significatly increase Command Central Docker image size!

To build customized image for Command Central run:

docker-compose build cc

Successful execution will end with something like this

BUILD SUCCESSFUL
Total time: 1 minute 21 seconds
 ---> d17f77f1cfcb
Removing intermediate container 6ab350c69242
Successfully built d17f77f1cfcb
Creating sagdevopsccserver_cc_1

Running custom built Command Central container

Run this command to launch your Command Central server container:

docker-compose up -d cc

Open https://localhost:8091/

To verify successful master repositories setup run:

docker-compose run --rm test

NOTE: it may take few minutes to complete, depending on the network speed

The successful result would look like this

[au:antunit] Target: test-repos-fixes-listing took 1.082 sec
[au:antunit] Target: test-client took 0.181 sec
[au:antunit] Target: test-repos-prods took 1.057 sec
[au:antunit] Target: test-repos-prods-listing took 111.189 sec
[au:antunit] Target: test-repos-fixes took 1.065 sec

BUILD SUCCESSFUL
Total time: 1 minute 56 seconds

To cleanup running containers run:

docker-compose down

Now you can use the docker image you've built in any other project

docker run --name mycc -d -p 8091:8091 mycc:9.12

These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.