{"action":"created","comment":{"url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/comments/199403403","pull_request_review_id":133513792,"id":199403403,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDE5OTQwMzQwMw==","diff_hunk":"@@ -0,0 +1,64 @@\n+# Deployment Operator Dashboard\n+\n+To inspect the state of an `ArangoDeployment` you can use `kubectl get ...` to inspect\n+the `status` of the resource itself, but to get the entire \"picture\" you also\n+must inspect the status of the `Pods` created for the deployment, the `PersistentVolumeClaims`,\n+the `PersistentVolumes`, the `Services` and some `Secrets`.\n+\n+The goal of the operator dashboard is to simplify this inspection process.\n+\n+The deployment operator dashboard provides:\n+\n+- A status overview of all `ArangoDeployment` it controls\n+- A status overview of all resources created by the operator (for an `ArangoDeployment`)\n+- Run the arangoinspector on deployments\n+- Instructions for upgrading deployments to newer versions\n+\n+It does not provide:\n+\n+- Direct access to the deployed database\n+- Anything that can already be done in the web-UI of the database or naturaly belongs there.\n+\n+The dashboard is a single-page web application that is served by the operator itself.\n+\n+## Design decisions\n+\n+### Leader only\n+\n+Since only the operator instance that won the leader election has the latest state of all\n+deployments, only that instance will serve dashboard requests.\n+\n+For this purpose, a `Service` is created when deploying the operator.\n+This service uses a `role=leader` selector to ensure that only the right instance\n+will be included in its list of endpoints.\n+\n+### Exposing the dashboard\n+\n+By default `Service` that selects the leading operator instance is not exposed outside the Kubernetes cluster.\n+Users must use `kubectl expose service ...` to add additional `Services` of type `LoadBalancer`\n+or `NodePort` to expose the dashboard if and how they want to.\n+\n+### Readonly behavior\n+\n+The dashboard only provides readonly functions.\n+When modifications to an `ArangoDeployment` are needed (e.g. when upgrading to a new version), the dashboard\n+will provide instructions for doing so using `kubectl` commands.\n+\n+In doing so, the requirements for authentication & access control of the dashboard itself remain limited,\n+while all possible authentication & access control features of Kubernetes are still available to ensure\n+a secure deployment.\n+\n+### Authentication\n+\n+The dashboard requires a username+password to gain access, unless it is started with a option to disable authentication.\n+This username+password pair is stored in standard basic authentication `Secret` in the Kubernetes cluster.\n+\n+### Frontend technology\n+\n+The frontend part of the dashboard will be build with React.","path":"docs/design/dashboard.md","position":58,"original_position":58,"commit_id":"177c679c2a8ac1e79594bf19e0d5af19c30159af","original_commit_id":"177c679c2a8ac1e79594bf19e0d5af19c30159af","user":{"login":"neunhoef","id":5286736,"node_id":"MDQ6VXNlcjUyODY3MzY=","avatar_url":"https://avatars3.githubusercontent.com/u/5286736?v=4","gravatar_id":"","url":"https://api.github.com/users/neunhoef","html_url":"https://github.com/neunhoef","followers_url":"https://api.github.com/users/neunhoef/followers","following_url":"https://api.github.com/users/neunhoef/following{/other_user}","gists_url":"https://api.github.com/users/neunhoef/gists{/gist_id}","starred_url":"https://api.github.com/users/neunhoef/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/neunhoef/subscriptions","organizations_url":"https://api.github.com/users/neunhoef/orgs","repos_url":"https://api.github.com/users/neunhoef/repos","events_url":"https://api.github.com/users/neunhoef/events{/privacy}","received_events_url":"https://api.github.com/users/neunhoef/received_events","type":"User","site_admin":false},"body":"\"build\" -> \"built\"","created_at":"2018-07-02T07:20:01Z","updated_at":"2018-07-02T07:20:22Z","html_url":"https://github.com/arangodb/kube-arangodb/pull/209#discussion_r199403403","pull_request_url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/comments/199403403"},"html":{"href":"https://github.com/arangodb/kube-arangodb/pull/209#discussion_r199403403"},"pull_request":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209"}}},"pull_request":{"url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209","id":198589557,"node_id":"MDExOlB1bGxSZXF1ZXN0MTk4NTg5NTU3","html_url":"https://github.com/arangodb/kube-arangodb/pull/209","diff_url":"https://github.com/arangodb/kube-arangodb/pull/209.diff","patch_url":"https://github.com/arangodb/kube-arangodb/pull/209.patch","issue_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues/209","number":209,"state":"open","locked":false,"title":"Dashboard design concept","user":{"login":"ewoutp","id":4750892,"node_id":"MDQ6VXNlcjQ3NTA4OTI=","avatar_url":"https://avatars0.githubusercontent.com/u/4750892?v=4","gravatar_id":"","url":"https://api.github.com/users/ewoutp","html_url":"https://github.com/ewoutp","followers_url":"https://api.github.com/users/ewoutp/followers","following_url":"https://api.github.com/users/ewoutp/following{/other_user}","gists_url":"https://api.github.com/users/ewoutp/gists{/gist_id}","starred_url":"https://api.github.com/users/ewoutp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ewoutp/subscriptions","organizations_url":"https://api.github.com/users/ewoutp/orgs","repos_url":"https://api.github.com/users/ewoutp/repos","events_url":"https://api.github.com/users/ewoutp/events{/privacy}","received_events_url":"https://api.github.com/users/ewoutp/received_events","type":"User","site_admin":false},"body":null,"created_at":"2018-07-02T07:07:54Z","updated_at":"2018-07-02T07:20:22Z","closed_at":null,"merged_at":null,"merge_commit_sha":"9ad623a595f98a30cbc82b8d16709458610efb92","assignee":{"login":"ewoutp","id":4750892,"node_id":"MDQ6VXNlcjQ3NTA4OTI=","avatar_url":"https://avatars0.githubusercontent.com/u/4750892?v=4","gravatar_id":"","url":"https://api.github.com/users/ewoutp","html_url":"https://github.com/ewoutp","followers_url":"https://api.github.com/users/ewoutp/followers","following_url":"https://api.github.com/users/ewoutp/following{/other_user}","gists_url":"https://api.github.com/users/ewoutp/gists{/gist_id}","starred_url":"https://api.github.com/users/ewoutp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ewoutp/subscriptions","organizations_url":"https://api.github.com/users/ewoutp/orgs","repos_url":"https://api.github.com/users/ewoutp/repos","events_url":"https://api.github.com/users/ewoutp/events{/privacy}","received_events_url":"https://api.github.com/users/ewoutp/received_events","type":"User","site_admin":false},"assignees":[{"login":"ewoutp","id":4750892,"node_id":"MDQ6VXNlcjQ3NTA4OTI=","avatar_url":"https://avatars0.githubusercontent.com/u/4750892?v=4","gravatar_id":"","url":"https://api.github.com/users/ewoutp","html_url":"https://github.com/ewoutp","followers_url":"https://api.github.com/users/ewoutp/followers","following_url":"https://api.github.com/users/ewoutp/following{/other_user}","gists_url":"https://api.github.com/users/ewoutp/gists{/gist_id}","starred_url":"https://api.github.com/users/ewoutp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ewoutp/subscriptions","organizations_url":"https://api.github.com/users/ewoutp/orgs","repos_url":"https://api.github.com/users/ewoutp/repos","events_url":"https://api.github.com/users/ewoutp/events{/privacy}","received_events_url":"https://api.github.com/users/ewoutp/received_events","type":"User","site_admin":false}],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":961085169,"node_id":"MDU6TGFiZWw5NjEwODUxNjk=","url":"https://api.github.com/repos/arangodb/kube-arangodb/labels/2%20-%20Working","name":"2 - Working","color":"CCCCCC","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209/commits","review_comments_url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209/comments","review_comment_url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/comments{/number}","comments_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues/209/comments","statuses_url":"https://api.github.com/repos/arangodb/kube-arangodb/statuses/177c679c2a8ac1e79594bf19e0d5af19c30159af","head":{"label":"arangodb:docs/dashboard","ref":"docs/dashboard","sha":"177c679c2a8ac1e79594bf19e0d5af19c30159af","user":{"login":"arangodb","id":5547849,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU1NDc4NDk=","avatar_url":"https://avatars0.githubusercontent.com/u/5547849?v=4","gravatar_id":"","url":"https://api.github.com/users/arangodb","html_url":"https://github.com/arangodb","followers_url":"https://api.github.com/users/arangodb/followers","following_url":"https://api.github.com/users/arangodb/following{/other_user}","gists_url":"https://api.github.com/users/arangodb/gists{/gist_id}","starred_url":"https://api.github.com/users/arangodb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arangodb/subscriptions","organizations_url":"https://api.github.com/users/arangodb/orgs","repos_url":"https://api.github.com/users/arangodb/repos","events_url":"https://api.github.com/users/arangodb/events{/privacy}","received_events_url":"https://api.github.com/users/arangodb/received_events","type":"Organization","site_admin":false},"repo":{"id":120325908,"node_id":"MDEwOlJlcG9zaXRvcnkxMjAzMjU5MDg=","name":"kube-arangodb","full_name":"arangodb/kube-arangodb","owner":{"login":"arangodb","id":5547849,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU1NDc4NDk=","avatar_url":"https://avatars0.githubusercontent.com/u/5547849?v=4","gravatar_id":"","url":"https://api.github.com/users/arangodb","html_url":"https://github.com/arangodb","followers_url":"https://api.github.com/users/arangodb/followers","following_url":"https://api.github.com/users/arangodb/following{/other_user}","gists_url":"https://api.github.com/users/arangodb/gists{/gist_id}","starred_url":"https://api.github.com/users/arangodb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arangodb/subscriptions","organizations_url":"https://api.github.com/users/arangodb/orgs","repos_url":"https://api.github.com/users/arangodb/repos","events_url":"https://api.github.com/users/arangodb/events{/privacy}","received_events_url":"https://api.github.com/users/arangodb/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/arangodb/kube-arangodb","description":"ArangoDB Kubernetes Operator - Start ArangoDB on Kubernetes in 5min","fork":false,"url":"https://api.github.com/repos/arangodb/kube-arangodb","forks_url":"https://api.github.com/repos/arangodb/kube-arangodb/forks","keys_url":"https://api.github.com/repos/arangodb/kube-arangodb/keys{/key_id}","collaborators_url":"https://api.github.com/repos/arangodb/kube-arangodb/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/arangodb/kube-arangodb/teams","hooks_url":"https://api.github.com/repos/arangodb/kube-arangodb/hooks","issue_events_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues/events{/number}","events_url":"https://api.github.com/repos/arangodb/kube-arangodb/events","assignees_url":"https://api.github.com/repos/arangodb/kube-arangodb/assignees{/user}","branches_url":"https://api.github.com/repos/arangodb/kube-arangodb/branches{/branch}","tags_url":"https://api.github.com/repos/arangodb/kube-arangodb/tags","blobs_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/refs{/sha}","trees_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/trees{/sha}","statuses_url":"https://api.github.com/repos/arangodb/kube-arangodb/statuses/{sha}","languages_url":"https://api.github.com/repos/arangodb/kube-arangodb/languages","stargazers_url":"https://api.github.com/repos/arangodb/kube-arangodb/stargazers","contributors_url":"https://api.github.com/repos/arangodb/kube-arangodb/contributors","subscribers_url":"https://api.github.com/repos/arangodb/kube-arangodb/subscribers","subscription_url":"https://api.github.com/repos/arangodb/kube-arangodb/subscription","commits_url":"https://api.github.com/repos/arangodb/kube-arangodb/commits{/sha}","git_commits_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/commits{/sha}","comments_url":"https://api.github.com/repos/arangodb/kube-arangodb/comments{/number}","issue_comment_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues/comments{/number}","contents_url":"https://api.github.com/repos/arangodb/kube-arangodb/contents/{+path}","compare_url":"https://api.github.com/repos/arangodb/kube-arangodb/compare/{base}...{head}","merges_url":"https://api.github.com/repos/arangodb/kube-arangodb/merges","archive_url":"https://api.github.com/repos/arangodb/kube-arangodb/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/arangodb/kube-arangodb/downloads","issues_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues{/number}","pulls_url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls{/number}","milestones_url":"https://api.github.com/repos/arangodb/kube-arangodb/milestones{/number}","notifications_url":"https://api.github.com/repos/arangodb/kube-arangodb/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/arangodb/kube-arangodb/labels{/name}","releases_url":"https://api.github.com/repos/arangodb/kube-arangodb/releases{/id}","deployments_url":"https://api.github.com/repos/arangodb/kube-arangodb/deployments","created_at":"2018-02-05T15:50:22Z","updated_at":"2018-06-29T16:18:22Z","pushed_at":"2018-07-02T07:07:54Z","git_url":"git://github.com/arangodb/kube-arangodb.git","ssh_url":"git@github.com:arangodb/kube-arangodb.git","clone_url":"https://github.com/arangodb/kube-arangodb.git","svn_url":"https://github.com/arangodb/kube-arangodb","homepage":"https://docs.arangodb.com/devel/Manual/Tutorials/Kubernetes/","size":13161,"stargazers_count":32,"watchers_count":32,"language":"Go","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":4,"mirror_url":null,"archived":false,"open_issues_count":18,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":4,"open_issues":18,"watchers":32,"default_branch":"master"}},"base":{"label":"arangodb:master","ref":"master","sha":"186133f5c2d39e612e306037a36f2214e944f492","user":{"login":"arangodb","id":5547849,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU1NDc4NDk=","avatar_url":"https://avatars0.githubusercontent.com/u/5547849?v=4","gravatar_id":"","url":"https://api.github.com/users/arangodb","html_url":"https://github.com/arangodb","followers_url":"https://api.github.com/users/arangodb/followers","following_url":"https://api.github.com/users/arangodb/following{/other_user}","gists_url":"https://api.github.com/users/arangodb/gists{/gist_id}","starred_url":"https://api.github.com/users/arangodb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arangodb/subscriptions","organizations_url":"https://api.github.com/users/arangodb/orgs","repos_url":"https://api.github.com/users/arangodb/repos","events_url":"https://api.github.com/users/arangodb/events{/privacy}","received_events_url":"https://api.github.com/users/arangodb/received_events","type":"Organization","site_admin":false},"repo":{"id":120325908,"node_id":"MDEwOlJlcG9zaXRvcnkxMjAzMjU5MDg=","name":"kube-arangodb","full_name":"arangodb/kube-arangodb","owner":{"login":"arangodb","id":5547849,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU1NDc4NDk=","avatar_url":"https://avatars0.githubusercontent.com/u/5547849?v=4","gravatar_id":"","url":"https://api.github.com/users/arangodb","html_url":"https://github.com/arangodb","followers_url":"https://api.github.com/users/arangodb/followers","following_url":"https://api.github.com/users/arangodb/following{/other_user}","gists_url":"https://api.github.com/users/arangodb/gists{/gist_id}","starred_url":"https://api.github.com/users/arangodb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arangodb/subscriptions","organizations_url":"https://api.github.com/users/arangodb/orgs","repos_url":"https://api.github.com/users/arangodb/repos","events_url":"https://api.github.com/users/arangodb/events{/privacy}","received_events_url":"https://api.github.com/users/arangodb/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/arangodb/kube-arangodb","description":"ArangoDB Kubernetes Operator - Start ArangoDB on Kubernetes in 5min","fork":false,"url":"https://api.github.com/repos/arangodb/kube-arangodb","forks_url":"https://api.github.com/repos/arangodb/kube-arangodb/forks","keys_url":"https://api.github.com/repos/arangodb/kube-arangodb/keys{/key_id}","collaborators_url":"https://api.github.com/repos/arangodb/kube-arangodb/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/arangodb/kube-arangodb/teams","hooks_url":"https://api.github.com/repos/arangodb/kube-arangodb/hooks","issue_events_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues/events{/number}","events_url":"https://api.github.com/repos/arangodb/kube-arangodb/events","assignees_url":"https://api.github.com/repos/arangodb/kube-arangodb/assignees{/user}","branches_url":"https://api.github.com/repos/arangodb/kube-arangodb/branches{/branch}","tags_url":"https://api.github.com/repos/arangodb/kube-arangodb/tags","blobs_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/refs{/sha}","trees_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/trees{/sha}","statuses_url":"https://api.github.com/repos/arangodb/kube-arangodb/statuses/{sha}","languages_url":"https://api.github.com/repos/arangodb/kube-arangodb/languages","stargazers_url":"https://api.github.com/repos/arangodb/kube-arangodb/stargazers","contributors_url":"https://api.github.com/repos/arangodb/kube-arangodb/contributors","subscribers_url":"https://api.github.com/repos/arangodb/kube-arangodb/subscribers","subscription_url":"https://api.github.com/repos/arangodb/kube-arangodb/subscription","commits_url":"https://api.github.com/repos/arangodb/kube-arangodb/commits{/sha}","git_commits_url":"https://api.github.com/repos/arangodb/kube-arangodb/git/commits{/sha}","comments_url":"https://api.github.com/repos/arangodb/kube-arangodb/comments{/number}","issue_comment_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues/comments{/number}","contents_url":"https://api.github.com/repos/arangodb/kube-arangodb/contents/{+path}","compare_url":"https://api.github.com/repos/arangodb/kube-arangodb/compare/{base}...{head}","merges_url":"https://api.github.com/repos/arangodb/kube-arangodb/merges","archive_url":"https://api.github.com/repos/arangodb/kube-arangodb/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/arangodb/kube-arangodb/downloads","issues_url":"https://api.github.com/repos/arangodb/kube-arangodb/issues{/number}","pulls_url":"https://api.github.com/repos/arangodb/kube-arangodb/pulls{/number}","milestones_url":"https://api.github.com/repos/arangodb/kube-arangodb/milestones{/number}","notifications_url":"https://api.github.com/repos/arangodb/kube-arangodb/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/arangodb/kube-arangodb/labels{/name}","releases_url":"https://api.github.com/repos/arangodb/kube-arangodb/releases{/id}","deployments_url":"https://api.github.com/repos/arangodb/kube-arangodb/deployments","created_at":"2018-02-05T15:50:22Z","updated_at":"2018-06-29T16:18:22Z","pushed_at":"2018-07-02T07:07:54Z","git_url":"git://github.com/arangodb/kube-arangodb.git","ssh_url":"git@github.com:arangodb/kube-arangodb.git","clone_url":"https://github.com/arangodb/kube-arangodb.git","svn_url":"https://github.com/arangodb/kube-arangodb","homepage":"https://docs.arangodb.com/devel/Manual/Tutorials/Kubernetes/","size":13161,"stargazers_count":32,"watchers_count":32,"language":"Go","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":4,"mirror_url":null,"archived":false,"open_issues_count":18,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":4,"open_issues":18,"watchers":32,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209"},"html":{"href":"https://github.com/arangodb/kube-arangodb/pull/209"},"issue":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/issues/209"},"comments":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/issues/209/comments"},"review_comments":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209/comments"},"review_comment":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/pulls/209/commits"},"statuses":{"href":"https://api.github.com/repos/arangodb/kube-arangodb/statuses/177c679c2a8ac1e79594bf19e0d5af19c30159af"}},"author_association":"COLLABORATOR"}}
{"actor":{"display_login":"neunhoef"}}