Jira Deployment Guide
Register Jira Splice application with Atlassian Admin Account
The Jira Splice application will need to be registered with Atlassian admin account to grant it permission to call the User Provisioning APIs. Follow the steps below to setup the Splice with the required information.
Login as Admin to
Atlassian Administration and click on the desired organisation
Go to Directory menu and click User Provisioning.
a) If the domain is not registered, the following screen is shown.
b) Go to Domains and register the domain.
c) Once a domain is registered, an option to create a Directory is provided under User Provisioning menu
d) On clicking the Create a directory button, the user is directed to a page to create the directory
e) Once the Directory Name is entered and Create button is clicked, the user is directed to a page where the Directory base URL and API key is shown. Copy the Directory base URL and API key and store in the application.properties file of the Jira Splice application.
f) Once all the setup for the directory is completed, the newly created directory will be shown under the User Provisioning menu
2. For basic authentication for the Jira cloud APIs, API token needs to be generated.
a) Follow the steps mentioned in https://docs.searchunify.com/Content/Content-Sources/Atlassian-Jira-Confluence-Authentication-Create-API-Token.htm to create an API token.
b) Save the generated token in the application.properties file of the Jira Splice application.
3. To provide the values to the following variables in application.yml by creating .env.yaml
Field Name | Field Description |
|---|---|
DOMAIN_URL | Jira Domain URL:https://iamsath.atlassian.net |
DOMAIN_API_TOKEN | API token for jira |
DIRECTORY_URL | Directory URL for JIra:https://api.atlassian.com/scim/directory/ |
DIRECTORY_ID | Directory ID generated in above steps. |
DIRECTORY_API_KEY | Password generated in above steps. |
BUSINESS_OWNER | Name of the business owner of the application |
CONNECTOR_DEBUG_LEVEL | Debug level for the connector |
IDHUB_HOSTNAME | The hostname /IP of IDHUB application |
IT_OWNER | Name of the IT owner of the application |
KEYCLOAK_ACCESS_TOKEN | Follow this document to generate access and refresh tokens |
KEYCLOAK_CLIENT_ID | The client ID of client under idhub.realm of Keyclock |
KEYCLOAK_REFRESH_TOKEN | Follow this document to generate access and refresh tokens |
KEYCLOAK_REALM | Tenant / Keycloack realm name |
SPLICE_DEBUG_LEVEL | Debug for Jira Splice project |
ADMIN_EMAIL | Admin Email(admin@iamsath.com) |
APP_DEFAULT_SEARCH_COUNT | Default search count for user and entitlements |
APP_DEFAULT_SLEEP_TIME | 3 gap needed between two API when user in new to Atlassian(not less that 80000 ms ) |
3.The .env.yaml should be like this
4. Generate the run.sh with the location of latest Jira image
#!/bin/bash# The user will need Cloud Run Admin and Service Account User roles in GCP to run the following commandgcloud run deploy \
dev28-jira-connector --image us-docker.pkg.dev/sath-lab/jira-splice/jira:latest \
--platform=managed --region=us-central1 --min-instances=1 --max-instances=4 \
--cpu=1 --cpu-throttling --memory=512Mi \
--port=7004 --allow-unauthenticated --timeout=300 \
--env-vars-file=".env.yaml"5. In the terminal run the command : ./run.sh to generate the service url or connector url.
Integrate Jira Splice with Connector Application
Latest Jira splice code is available in the link https://bitbucket.org/sath-inc/jira-splice/src/dev/ . The connector url is https://dev28-jira-connector-ac3o25y5jq-uc.a.run.app.
Follow the instructions here- IDHub Splice / Connector - Implementation Guide to build the Jira Splice application with the Connector Application
Generate access token for the client of the particular realm and add it to the application.yml file.
Run Connector Application
Place the ${project.artifactId}-${project.version}-with-connector-application-${idhub.connection-application.version}.jar file along with the application.yml file in a separate folder and execute java --add-exports=java.naming/com.sun.jndi.ldap=ALL-UNNAMED -jar jira-splice-1.0.0-with-connector-application-2.1.0.jar command in a terminal.