{"__v":0,"_id":"58b8a579234a0a0f00ad2c91","category":{"__v":3,"_id":"55d7c2939510f00d007ec6fe","pages":["55d7c2a59510f00d007ec6ff","55d7c45f9510f00d007ec705","55e3ddd48435a40d0025f009"],"project":"55c505b41469ad2500fa2ab7","version":"55d3b644f77e6d0d00b1b273","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-22T00:30:11.015Z","from_sync":false,"order":5,"slug":"runbooks","title":"Runbooks"},"project":"55c505b41469ad2500fa2ab7","user":"55c50e9ca13abc25008c9088","version":{"__v":6,"_id":"55d3b644f77e6d0d00b1b273","project":"55c505b41469ad2500fa2ab7","createdAt":"2015-08-18T22:48:36.632Z","releaseDate":"2015-08-18T22:48:36.632Z","categories":["55d3b645f77e6d0d00b1b274","55d3b645f77e6d0d00b1b275","55d3b645f77e6d0d00b1b276","55d3b645f77e6d0d00b1b277","55d3b645f77e6d0d00b1b278","55d3b645f77e6d0d00b1b279","55d3b645f77e6d0d00b1b27a","55d3b645f77e6d0d00b1b27b","55d3b645f77e6d0d00b1b27c","55d3b645f77e6d0d00b1b27d","55d7c2939510f00d007ec6fe","56fac9925df15a20002972a2","56fb2f7668e1d30e00a0b672","583498d411e8af2500f6b334","58e52a180ab7b03b00f4a97a"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-02T23:06:33.776Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"You can either have a GITHUB repo or a GITHUB ENTERPRISE repo but not both.\",\n  \"body\": \"For GITHUB.COM integration, refer [here](http://docs.neptune.io/v1.1/docs/private-github-runbooks)\"\n}\n[/block]\nSeparate Github Enterprise repository for runbooks allows you to enforce strict policy of \"not allowing the editing of runbooks directly from UI in an ad-hoc fashion\". Neptune provides seamless integration with your existing Github Enterprise runbook repository. This repo will help you version the runbooks, introduce a review process and control who's allowed to edit them.\n\n**How it works?**\n 1. Create a new Github Enterprise user for automation or use one of the existing bot users.\n 2. Create a read-only team in your organization, if not presently already. Add the user to read-only team and give read-only access to the repo for this team.\n 3. Generate access key for the automation user and finish integration in Neptune.\n 4. Once you integrate Github Enterprise with Neptune, you can only use Github Enterprise runbooks in Neptune app and ad-hoc editing of runbooks is no longer allowed.\n\nFollow these detailed steps to integrate your Github Enterprise repo.\n\n## Step 1: Create a new Github Enterprise user or use one of existing bot/automation users\n\nMake sure you verify the email address of user using this Github since it is required for future steps.\n\n## Step 2: Create a read-only team, if you do not have one already in your organization\n\nIn your Github Enterprise account, go to (1) Repo Settings (2) Collaborators & teams (3) Create new team\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/526e619-14UbexbbRUOZF2ZOQmqt_github_readonly_team.png\",\n        \"14UbexbbRUOZF2ZOQmqt_github_readonly_team.png\",\n        1002,\n        358,\n        \"#f4f4f3\"\n      ]\n    }\n  ]\n}\n[/block]\nGive a name to the team and add description.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2fb6451-SrQlRJq4QNCM9CMuTrbq_github_readonly_team2.png\",\n        \"SrQlRJq4QNCM9CMuTrbq_github_readonly_team2.png\",\n        777,\n        507,\n        \"#758252\"\n      ]\n    }\n  ]\n}\n[/block]\n## Step 3: Add the Github user to read-only team\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2a73f61-DglVwca8T0FNNTK1wvt5_github_add_member.png\",\n        \"DglVwca8T0FNNTK1wvt5_github_add_member.png\",\n        1023,\n        389,\n        \"#e2e5e3\"\n      ]\n    }\n  ]\n}\n[/block]\n## Step 4: Associate required repositories with the read-only team\n\nYou might need only one repository which has runbooks.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/84dedba-StUakaHcR6yjeMeBYenR_github_readonly_repo.png\",\n        \"StUakaHcR6yjeMeBYenR_github_readonly_repo.png\",\n        1010,\n        414,\n        \"#eceeed\"\n      ]\n    }\n  ]\n}\n[/block]\n## Step 5: Generate an access token for the Github user and copy it to clipboard\n \nIn Github, go to (1) Account -->  (2) Settings --> (3) Personal access tokens\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/84f2a83-I5Odge5BQ0axdLIE2EYt_gitToken1.png\",\n        \"I5Odge5BQ0axdLIE2EYt_gitToken1.png\",\n        1375,\n        675,\n        \"#edeeed\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2df4728-voHNsNzATf7h2OYtDWxA_gittoken2.png\",\n        \"voHNsNzATf7h2OYtDWxA_gittoken2.png\",\n        1108,\n        671,\n        \"#edeeee\"\n      ]\n    }\n  ]\n}\n[/block]\n**You are done with all steps on the Github front. Now you can open Neptune app.**\n\n## Step 6: Navigate to integrations page in Neptune\n\nClick on \"Optional integrations\" and then click on Github Enterprise image.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a1f472c-Screen_Shot_2017-03-02_at_4.07.12_PM.png\",\n        \"Screen Shot 2017-03-02 at 4.07.12 PM.png\",\n        1419,\n        785,\n        \"#cbd2dc\"\n      ]\n    }\n  ]\n}\n[/block]\n## Step 7: Add your Github Enterprise hostname, auth token and runbook repository details\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0dea418-Screen_Shot_2017-03-02_at_4.08.22_PM.png\",\n        \"Screen Shot 2017-03-02 at 4.08.22 PM.png\",\n        1194,\n        578,\n        \"#f1f1f1\"\n      ]\n    }\n  ]\n}\n[/block]\n## Step 8: Now you will be able to see your runbooks in the drop-down lists while creating a rule\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d9d64c8-2dLScubRQ2EdHgAPi3LU_select_runbook.png\",\n        \"2dLScubRQ2EdHgAPi3LU_select_runbook.png\",\n        1378,\n        733,\n        \"#080707\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Neptune - Github Enterprise Integration","slug":"private-github-enterprise-runbooks","type":"basic","title":"Private Github Enterprise runbooks"}

Private Github Enterprise runbooks

Neptune - Github Enterprise Integration

[block:callout] { "type": "info", "title": "You can either have a GITHUB repo or a GITHUB ENTERPRISE repo but not both.", "body": "For GITHUB.COM integration, refer [here](http://docs.neptune.io/v1.1/docs/private-github-runbooks)" } [/block] Separate Github Enterprise repository for runbooks allows you to enforce strict policy of "not allowing the editing of runbooks directly from UI in an ad-hoc fashion". Neptune provides seamless integration with your existing Github Enterprise runbook repository. This repo will help you version the runbooks, introduce a review process and control who's allowed to edit them. **How it works?** 1. Create a new Github Enterprise user for automation or use one of the existing bot users. 2. Create a read-only team in your organization, if not presently already. Add the user to read-only team and give read-only access to the repo for this team. 3. Generate access key for the automation user and finish integration in Neptune. 4. Once you integrate Github Enterprise with Neptune, you can only use Github Enterprise runbooks in Neptune app and ad-hoc editing of runbooks is no longer allowed. Follow these detailed steps to integrate your Github Enterprise repo. ## Step 1: Create a new Github Enterprise user or use one of existing bot/automation users Make sure you verify the email address of user using this Github since it is required for future steps. ## Step 2: Create a read-only team, if you do not have one already in your organization In your Github Enterprise account, go to (1) Repo Settings (2) Collaborators & teams (3) Create new team [block:image] { "images": [ { "image": [ "https://files.readme.io/526e619-14UbexbbRUOZF2ZOQmqt_github_readonly_team.png", "14UbexbbRUOZF2ZOQmqt_github_readonly_team.png", 1002, 358, "#f4f4f3" ] } ] } [/block] Give a name to the team and add description. [block:image] { "images": [ { "image": [ "https://files.readme.io/2fb6451-SrQlRJq4QNCM9CMuTrbq_github_readonly_team2.png", "SrQlRJq4QNCM9CMuTrbq_github_readonly_team2.png", 777, 507, "#758252" ] } ] } [/block] ## Step 3: Add the Github user to read-only team [block:image] { "images": [ { "image": [ "https://files.readme.io/2a73f61-DglVwca8T0FNNTK1wvt5_github_add_member.png", "DglVwca8T0FNNTK1wvt5_github_add_member.png", 1023, 389, "#e2e5e3" ] } ] } [/block] ## Step 4: Associate required repositories with the read-only team You might need only one repository which has runbooks. [block:image] { "images": [ { "image": [ "https://files.readme.io/84dedba-StUakaHcR6yjeMeBYenR_github_readonly_repo.png", "StUakaHcR6yjeMeBYenR_github_readonly_repo.png", 1010, 414, "#eceeed" ] } ] } [/block] ## Step 5: Generate an access token for the Github user and copy it to clipboard In Github, go to (1) Account --> (2) Settings --> (3) Personal access tokens [block:image] { "images": [ { "image": [ "https://files.readme.io/84f2a83-I5Odge5BQ0axdLIE2EYt_gitToken1.png", "I5Odge5BQ0axdLIE2EYt_gitToken1.png", 1375, 675, "#edeeed" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/2df4728-voHNsNzATf7h2OYtDWxA_gittoken2.png", "voHNsNzATf7h2OYtDWxA_gittoken2.png", 1108, 671, "#edeeee" ] } ] } [/block] **You are done with all steps on the Github front. Now you can open Neptune app.** ## Step 6: Navigate to integrations page in Neptune Click on "Optional integrations" and then click on Github Enterprise image. [block:image] { "images": [ { "image": [ "https://files.readme.io/a1f472c-Screen_Shot_2017-03-02_at_4.07.12_PM.png", "Screen Shot 2017-03-02 at 4.07.12 PM.png", 1419, 785, "#cbd2dc" ] } ] } [/block] ## Step 7: Add your Github Enterprise hostname, auth token and runbook repository details [block:image] { "images": [ { "image": [ "https://files.readme.io/0dea418-Screen_Shot_2017-03-02_at_4.08.22_PM.png", "Screen Shot 2017-03-02 at 4.08.22 PM.png", 1194, 578, "#f1f1f1" ] } ] } [/block] ## Step 8: Now you will be able to see your runbooks in the drop-down lists while creating a rule [block:image] { "images": [ { "image": [ "https://files.readme.io/d9d64c8-2dLScubRQ2EdHgAPi3LU_select_runbook.png", "2dLScubRQ2EdHgAPi3LU_select_runbook.png", 1378, 733, "#080707" ] } ] } [/block]