Setting up CloudMunch Instance

The following steps helps your through installing CloudMunch into your Container Infrastructure.

1. Download and Install

Please review the requirements before downloading. Find here both download and installation instructions for CloudMunch deployment. Please note the value for the WEB_URL that you configure during the local installation. That value will be used in the next steps.

2. Set-up the Platform

At the end of step 1, the platform will be in SETUP mode and needs to be configured before it can be used. 

To do that, navigate to the WEB_URL defined in step 1. A setup wizard will be presented to walk through a series of steps. Let's review the steps.

Configure OAuth for Google

This configuration will be used for all Google Analytics insights data.

 

The above diagram indicates the details that are needed for configuration. The below table indicates details for each fields needed.

1 Client ID Client ID is the ID of the Application created using Google Authentication. 
2 Client Secret Client Secret is the secret generated for the ID registered for Google Authentication. 

Step 3 provides details of how to set up the app in Google.

Configure OAuth for Github

This configuration will be used for all Github interfaces, both insights and delivery functions.

 

The above diagram indicates the fields to be provided and their details.The below table indicates the details of each field needed.

1 Application Name Application name the name of the Application created using Google Authentication.
2 Client ID Client ID is the ID of the Application created using Google Authentication. 
3 Client Secret Client Secret is the secret generated for the ID registered for Google Authentication. 

Step 4 provides details of how to set an OAuth application in GitHub.

Configure Slack Integration

This configuration helps CloudMunch to communicate with various users of CloudMunch via ChatOps interfaces. 

CloudMunch uses two kinds of integration, one to interface with admin access, to create channels, to create users and also to get user details - this will be performed using API Token provided

CloudMunch also uses Incoming WebHook integration for sending chatops messages for all activities by teams.

 

The above diagram shows the set-up page for the same. The below table provides details for each field.

1 Support Channel This is the support channel used by CloudMunch to send any support messages with respect to the activities in CloudMunch platform
2 Access/API Token API Token used by CloudMunch to create channels, create users and get user details.
3 Webhook URL Web Hook used to send messages to various team channels

Configure Mail

1 SMTP Host SMTP is the protocol (method) used to send email between mail servers, and by your email software to submit outgoing email
2 SMTP Port Port of SMTP server to be configured
3 User Name Your mail User name
4 Password Your mail Password
5 From From mail ID
6 Secure Yes or No
7 Masked Yes or No

3. Setting up OAUTH App for Google Authentication

Please find here google documentation for the set up and a reference video to help set-up as below

 

Note : Please replace apitest2.php as api/ in Authorized redirect URLs

4. Setting up OAUTH App for Github Authentication

Please find here GitHub documentation for the OAuth application setup.

Refer the below gif for the setup

 

Note : Please replace apitest2.php as api/ in Authorization callback URL

5. Getting Slack Credentials

Please find here Slack documentation for getting API token and here Slack documentation for incoming webhook configuration.