diff --git a/docs/source/index.rst b/docs/source/index.rst index 3451918..8976992 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,6 +9,7 @@ Sync2Jira documentation quickstart config-file continuous_deployment + sync_page .. toctree:: diff --git a/docs/source/sync_page.rst b/docs/source/sync_page.rst new file mode 100644 index 0000000..0e17bf8 --- /dev/null +++ b/docs/source/sync_page.rst @@ -0,0 +1,22 @@ +Sync Page +====================== +We noticed that sometimes tickets would be lost and not sync. This would require taking down the entire service in order to re-sync that one ticket. To fix this we created a flask micro-service that provides a UI for users to sync individual repos. + +The following environmental variables will have to be set: + +Related to OpenShift: + 1. :code:`CA_URL` :: CA URL used for sync2jira + 2. :code:`DEFAULT_SERVER` :: Default server to use for mailing + 3. :code:`DEFAULT_FROM` :: Default from to use for mailing + 4. :code:`USER` :: JIRA username + 5. :code:`CONFLUENCE_SPACE` :: Confluence space (should be set to "mock_confluence_space" as we don't want any confluence syncing) + 6. :code:`INITIALIZE` :: True/False Initialize our repos on startup (Should be set to "0") + 7. :code:`IMAGE_URL` :: Image URL:TAG to pull from + 8. :code:`JIRA_PNT_PASS` :: PNT password in base64 + 9. :code:`JIRA_OMEGAPRIME_PASS` :: Omegaprime password in base64 + 10. :code:`GITHUB_TOKEN` :: GitHub token in base64 + 11. :code:`PAAS_DOMAIN` :: Domain to use for the service + +You can also use the OpenShift template to quickly deploy this service (it can be found in the repo under :code:`openshift/sync2jira-sync-page-template.yaml`) + +Once deployed, you can go to the url :code:`sync2jira-page-sync.PAAS_DOMAIN` to select and sync individual repos! \ No newline at end of file diff --git a/openshift/sync2jira-sync-page-template.yaml b/openshift/sync2jira-sync-page-template.yaml index 3d36d06..60b1378 100644 --- a/openshift/sync2jira-sync-page-template.yaml +++ b/openshift/sync2jira-sync-page-template.yaml @@ -22,8 +22,8 @@ parameters: displayName: Confluence space required: true value: "mock_confluence_space" -- name: INITILIZE - displayName: True/False Initilize our repos on startup +- name: INITIALIZE + displayName: True/False Initialize our repos on startup value: "0" - name: IMAGE_URL displayName: Image URL:TAG to pull from