Skip to content

Setup.md

Latest commit

 

History

History
174 lines (138 loc) · 5.65 KB

Setup.md

File metadata and controls

174 lines (138 loc) · 5.65 KB

<img src="https://pbs.twimg.com/profile_images/461570480298663937/N78Jgl-f_400x400.jpeg" width="150";height="50"/>Image

Build Hygieia

mvn clean install package

The above command will build all components for Hygieia.

Hygieia Setup Instructions

The following components are required to run Hygieia:

Database

  • MongoDB 3.0+
    • Download & Installation instructions
    • Configure MongoDB * Go to the bin directory of your mongodb installation and run the following command to start the mongodb do make sure that data directory should pre-exist at the target location
      mongod --dbpath < path to the data directory>
      for e.g /usr/bin/mongodb-linux-x86_64-2.6.3/bin/mongod --dbpath /dev/data/db * Run the following commands as shown below at mongodb command prompt /usr/bin/mongodb-linux-x86_64-2.6.3/bin/mongo 
       $ mongo  
 MongoDB shell version: 3.0.4
 connecting to: test  

 > use dashboardb
 switched to db dashboardb
 > db.createUser(
          {
            user: "dashboarduser",
            pwd: "1qazxSw2",
            roles: [
               {role: "readWrite", db: "dashboarddb"}
                    ]
            })
        Successfully added user: {
          "user" : "dashboarduser",
          "roles" : [
          {
            "role" : "readWrite",
            "db" : "dashboarddb"
          }
          ]
        }  
        ```

We recommend that you download MongoDB clients(RoboMongo etc) to connect to your local running Database and make sure that dashboarddb is created and you are successfully able to connect to it.

API Layer

Please click on the link below to learn about how to build and run the API layer

Tool Collectors

  • In general all the collectors can be run using the following command
java -jar <Path to collector-name.jar> --spring.config.name=<prefix for properties> --spring.config.location=<path to properties file location>

For each individual collector setup click on the links below

You can pick and choose which collectors are applicable for your DevOps toolset or you can write your own collector and plug it in.

UI Layer

Please click on the link below to learn about how to build and run the UI layer

Configure Proxy

Hygieia supports proxy authentication for working behind corporate firewalls. For development, please refer to the following configuration differences; for deployment/operations, please refer to the subsequent sub-section:

Proxy Config: Developer

Update your Maven settings.xml file:

...
<proxies>
       ...
       <proxy>
               <id>your-proxy-id</id>
               <active>true</active>
               <protocol>http</protocol>
               <host>your.proxy.domain.name</host>
               <port>8080</port>
               <!-- For authenticated proxy, please set the following, as well -->
               <username>companyId999</username>
               <password>yourPassword</password>
               <nonProxyHosts>*.local</nonProxyHosts>
       </proxy>
       ...
 </proxies>
...

Additionally, set the following export variables:

export HTTP_PROXY=http://companyId999:yourPassword@your.proxy.domain.name:8080
export HTTPS_PROXY=http://companyId999:yourPassword@your.proxy.domain.name:8080
export JAVA_OPTS="$JAVA_OPTS -Dhttp.proxyHost=your.proxy.domain.name -Dhttp.proxyPort=8080 -Dhttp.proxyUser=companyId999 -Dhttp.proxyPassword=yourPassword"
# This option may be duplicative if you have already updated your
# Maven settings.xml file, but will only help:
export MAVEN_OPTS="$MAVEN_OPTS -Dhttp.proxyHost=your.proxy.domain.name -Dhttp.proxyPort=8080 -Dhttp.proxyUser=companyId999 -Dhttp.proxyPassword=yourPassword"

Tests should now run/pass when built from behind a corporate proxy, even if it is an authenticated proxy

Proxy Config: Deployment / Operations

Only the above proxy settings (non authentication) may required to be set on your deployment instance. Additionally, please updated all property files for each collector/API configuration with their specific proxy setting property.

Build Docker images

  • Build the API Image
mvn clean package
mvn -pl api docker:build
  • Build the UI Image
mvn -pl UI docker:build
  • Bring up the container images
docker-compose up -d
  • Create user in mongo
mongo 192.168.64.2/admin  --eval 'db.getSiblingDB("dashboard").createUser({user: "db", pwd: "dbpass", roles: [{role: "readWrite", db: "dashboard"}]})'
  • Make sure everything is restarted it may fail if the user doesn't exist at start up time
docker-compose restart
  • Get the port for the UI
docker port hygieia-ui

Start Collectors

  • To start individual collector as a background process please run the command in below format
    • On linux platform
nohup java -jar <collector-name>.jar --spring.config.name=<property file name> & >/dev/null