Collectors

Tool Collectors

Generally, you can run the collectors 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>

You may choose the collectors applicable to your DevOps toolset from the list of supported collectors. In addition, you may write your own collector and plug it in to match your DevOps toolset.

Supported Collectors

Hygieia supports the following collectors Inventory:

• Build Collectors
  • Bamboo
  • Jenkins
  • Jenkins-codequality
  • Jenkins Cucumber
  • Sonar
• Cloud Collectors
  • AWS
• Deploy Collectors
  • uDeploy
  • XLDeploy
• Feature Collectors
  • Jira
  • VersionOne
  • Gitlab
  • Rally
• Miscellaneous Collectors
  • Chat Ops
  • Score
• SCM Collectors
  • Bitbucket
  • GitHub
  • Gitlab
  • Subversion
  • GitHub GraphQL - Currently Unavailable
• Performance Collector
  • AppDynamics
• Configuration Management Database (CMDB)
  • HP Service Manager (HPSM)
• Library Policy
  • Nexus IQ
  • WhiteSource
• Artifact Repository
  • Artifactory

Encrypted Properties

Properties that should not be sorted in plain text are first encrypted and then decrypted to make them intelligible using Jasypt. Encrypted properties are enclosed in the keyword ENC(), i.e., ENC(thisisanencryptedproperty).

To generate an encrypted property, run the following command:

java -cp ~/.m2/repository/org/jasypt/jasypt/1.9.2/jasypt-1.9.2.jar  org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="dbpassword" password=hygieiasecret algorithm=PBEWithMD5AndDES

The values of the command options indicate the following:

• dbpassword - Property value being encrypted

• hygieiasecret - The secret password

When you run the API, this secret password is used as the input value in the following system property for decryption:

-Djasypt.encryptor.password=hygieiasecret

When using Docker, add the environment variable in the following command:

docker run -t -p 8080:8080 -v ./logs:/hygieia/logs -e "SPRING_DATA_MONGODB_HOST=127.0.0.1" -e "JASYPT_ENCRYPTOR_PASSWORD=hygieiasecret" -i hygieia-api:latest

For additional information on encrypting properties in Spring Boot Applications, see jasypt spring boot documentation.

When using GitLab CI Runner, specify the value for JASPYT_ENCRYPTOR_PASSWORD as a secure variable. To add additional secure variables to a GitLab project, go to your project’s Settings > Variable > Add Variable.

Note: A secure variable’s value is not visible in the build log and only a project administrator can configure this value.

Encryption for Private Repos

Encryption for private repositories requires that you generate a secret key and add it to your repository settings files. The steps for encrypting private repositories are as follows:

• Step 1: From the core module, generate a secret key.

   java -jar <path-to-jar>/core-2.0.5-SNAPSHOT.jar com.capitalone.dashboard.util.Encryption
  

• Step 2: Add the generated key to the API properties file.

   #api.properties
   key=<your-generated-key>
  

• Step 3 Add that same generated key to your repository settings file. This key is required for the target collector to decrypt your saved repository password.

  For example, if your repo is GitHub, add the following to the github.properties file:

   #github.properties
   github.key=<your-generated-key>