{"action":"created","comment":{"url":"https://api.github.com/repos/projectcalico/calico-docker/pulls/comments/42818982","id":42818982,"diff_hunk":"@@ -0,0 +1,160 @@\n+\n+# User guide for 'calicoctl config' commands\n+\n+This sections describes the `calicoctl config` commands.\n+\n+The `calicoctl config` command allows users to view or modify \n+low-level component configurations for Felix and BGP.\n+\n+Read the [calicoctl command line interface user guide](../calicoctl.md) for a full list of calicoctl commands.\n+\n+## Displaying the help text for 'calicoctl config' commands\n+\n+Run `calicoctl config --help` to display the following help menu for the \n+calicoctl config commands.\n+\n+```\n+\n+Usage:\n+  calicoctl config felix <NAME> [<VALUE>|--remove] [--force]\n+  calicoctl config bgp <NAME> [<VALUE>|--remove] [--force]\n+  calicoctl config node bgp <NAME> [<VALUE>|--remove] [--force]\n+\n+Description:\n+  Configure or show low-level component configuration for Felix and BGP.\n+\n+Options:\n+ --remove  Remove the configuration entry.\n+ --force   Force update of configuration entry even if key value is unknown,\n+           or the value is not recognized as valid.\n+\n+Valid configuration:\n+  Command         | <NAME>   | <VALUE>s\n+------------------+----------+-----------------------------------------\n+  config felix    | loglevel | none debug info warning error critical\n+  config bgp      | loglevel | none debug info\n+  config node bgp | loglevel | none debug info\n+\n+Warnings:\n+  -  Changing the global BGP logging levels using the `calicoctl config bgp`\n+     command may cause all BGP sessions to bounce potentially resulting in a\n+     transient loss of service.  If you need to change the logging level for\n+     BGP, it is recommended to change the levels on a per-node basis using\n+     the `calicoctl config node bgp` command.\n+\n+```\n+\n+## calicoctl config commands\n+\n+\n+### calicoctl config felix <NAME> \n+This command allows you to show or modify key values for configuration \n+associated with the Felix process.\n+\n+Currently, you can modify the following:\n+```\n+  Command         | <NAME>   | <VALUE>s\n+------------------+----------+-----------------------------------------\n+  config felix    | loglevel | none debug info warning error critical\n+```\n+\n+This command can be run on any Calico node.\n+\n+Command syntax:\n+\n+```\n+calicoctl config felix <NAME> [<VALUE>|--remove] [--force]\n+\n+    <NAME>: Config variable key in question.\n+    <VALUE>: Value to assign to the config variable.\n+\n+    --remove: Remove the config key value.\n+    --force: Run command to make changes, bypassing warnings.\n+```\n+\n+Examples:\n+\n+```\n+$ calicoctl config felix loglevel\n+info\n+\n+$ calicoctl config felix loglevel debug\n+\n+$ calicoctl config felix loglevel --remove\n+Value removed\n+```\n+\n+### calicoctl config bgp <NAME> \n+This command allows you to show or modify key values for configuration \n+associated with the BGP process.\n+\n+Currently, you can modify the following:\n+```\n+  Command         | <NAME>   | <VALUE>s\n+------------------+----------+----------------\n+  config bgp      | loglevel | none debug info\n+```\n+\n+This command can be run on any Calico node.\n+\n+Command syntax:\n+\n+```\n+calicoctl config bgp <NAME> [<VALUE>|--remove] [--force]\n+\n+    <NAME>: Config variable key in question.\n+    <VALUE>: Value to assign to the config variable.\n+\n+    --remove: Remove the config key value.\n+    --force: Run command to make changes, bypassing warnings.\n+```\n+\n+Examples:\n+\n+```\n+$ calicoctl config bgp loglevel\n+info\n+\n+$ calicoctl config bgp loglevel debug\n+\n+\n+$ calicoctl config bgp loglevel --remove\n+Value removed\n+```\n+\n+### calicoctl config node bgp <NAME> \n+This command allows you to show or modify key values for configuration \n+associated with the BGP process on individual nodes.\n+\n+Currently, you can modify the following:\n+```\n+  Command         | <NAME>   | <VALUE>s\n+------------------+----------+----------------\n+  config node bgp | loglevel | none debug info\n+```\n+\n+This command can be run on any Calico node.\n+\n+Command syntax:\n+\n+```\n+calicoctl config node bgp <NAME> [<VALUE>|--remove] [--force]\n+\n+    <NAME>: Config variable key in question.\n+    <VALUE>: Value to assign to the config variable.\n+\n+    --remove: Remove the config key value.\n+    --force: Run command to make changes, bypassing warnings.\n+```","path":"docs/calicoctl/config.md","position":148,"original_position":148,"commit_id":"4ac852190c77092bd8da8d9db23e5e99519a6ee3","original_commit_id":"4ac852190c77092bd8da8d9db23e5e99519a6ee3","user":{"login":"spikecurtis","id":5375600,"avatar_url":"https://avatars.githubusercontent.com/u/5375600?v=3","gravatar_id":"","url":"https://api.github.com/users/spikecurtis","html_url":"https://github.com/spikecurtis","followers_url":"https://api.github.com/users/spikecurtis/followers","following_url":"https://api.github.com/users/spikecurtis/following{/other_user}","gists_url":"https://api.github.com/users/spikecurtis/gists{/gist_id}","starred_url":"https://api.github.com/users/spikecurtis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/spikecurtis/subscriptions","organizations_url":"https://api.github.com/users/spikecurtis/orgs","repos_url":"https://api.github.com/users/spikecurtis/repos","events_url":"https://api.github.com/users/spikecurtis/events{/privacy}","received_events_url":"https://api.github.com/users/spikecurtis/received_events","type":"User","site_admin":false},"body":"why remove and force?","created_at":"2015-10-22T23:26:29Z","updated_at":"2015-10-22T23:26:29Z","html_url":"https://github.com/projectcalico/calico-docker/pull/532#discussion_r42818982","pull_request_url":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532","_links":{"self":{"href":"https://api.github.com/repos/projectcalico/calico-docker/pulls/comments/42818982"},"html":{"href":"https://github.com/projectcalico/calico-docker/pull/532#discussion_r42818982"},"pull_request":{"href":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532"}}},"pull_request":{"url":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532","id":47718527,"html_url":"https://github.com/projectcalico/calico-docker/pull/532","diff_url":"https://github.com/projectcalico/calico-docker/pull/532.diff","patch_url":"https://github.com/projectcalico/calico-docker/pull/532.patch","issue_url":"https://api.github.com/repos/projectcalico/calico-docker/issues/532","number":532,"state":"open","locked":false,"title":"Calicoctl Documentation","user":{"login":"TrimBiggs","id":1302077,"avatar_url":"https://avatars.githubusercontent.com/u/1302077?v=3","gravatar_id":"","url":"https://api.github.com/users/TrimBiggs","html_url":"https://github.com/TrimBiggs","followers_url":"https://api.github.com/users/TrimBiggs/followers","following_url":"https://api.github.com/users/TrimBiggs/following{/other_user}","gists_url":"https://api.github.com/users/TrimBiggs/gists{/gist_id}","starred_url":"https://api.github.com/users/TrimBiggs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TrimBiggs/subscriptions","organizations_url":"https://api.github.com/users/TrimBiggs/orgs","repos_url":"https://api.github.com/users/TrimBiggs/repos","events_url":"https://api.github.com/users/TrimBiggs/events{/privacy}","received_events_url":"https://api.github.com/users/TrimBiggs/received_events","type":"User","site_admin":false},"body":"Documentation explaining how each calicoctl command works.\r\n\r\nThis PR contains a script that shall be run during the build/release process that autogenerates documentation based on the docopt data in each calicoctl file.  When a calicoctl command is added, the script will ensure that the user has run the script and added additional information about each command.  If the script finds that a doc has not been added/updated, the script will throw an error\r\n\r\n**Implementation TODOs**\r\n- [ ] Throw error if docs not generated\r\n- [ ] Flag to ignore error\r\n- [ ] Check template generator for additional improvements\r\n- [ ] Flag when commands in doc no longer exist or have not been updated\r\n\r\n**Documentation command TODOs**\r\n- [x] bgp\r\n- [x] checksystem\r\n- [x] config\r\n- [x] container\r\n- [x] diags\r\n- [x] endpoint\r\n- [x] ipam\r\n- [x] node\r\n- [x] pool\r\n- [x] profile\r\n- [x] status\r\n- [x] version","created_at":"2015-10-14T21:38:52Z","updated_at":"2015-10-22T23:26:29Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c232d5427e5efe6be58a773a23b54d092d00dba7","assignee":{"login":"spikecurtis","id":5375600,"avatar_url":"https://avatars.githubusercontent.com/u/5375600?v=3","gravatar_id":"","url":"https://api.github.com/users/spikecurtis","html_url":"https://github.com/spikecurtis","followers_url":"https://api.github.com/users/spikecurtis/followers","following_url":"https://api.github.com/users/spikecurtis/following{/other_user}","gists_url":"https://api.github.com/users/spikecurtis/gists{/gist_id}","starred_url":"https://api.github.com/users/spikecurtis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/spikecurtis/subscriptions","organizations_url":"https://api.github.com/users/spikecurtis/orgs","repos_url":"https://api.github.com/users/spikecurtis/repos","events_url":"https://api.github.com/users/spikecurtis/events{/privacy}","received_events_url":"https://api.github.com/users/spikecurtis/received_events","type":"User","site_admin":false},"milestone":null,"commits_url":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532/commits","review_comments_url":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532/comments","review_comment_url":"https://api.github.com/repos/projectcalico/calico-docker/pulls/comments{/number}","comments_url":"https://api.github.com/repos/projectcalico/calico-docker/issues/532/comments","statuses_url":"https://api.github.com/repos/projectcalico/calico-docker/statuses/4ac852190c77092bd8da8d9db23e5e99519a6ee3","head":{"label":"TrimBiggs:calicoctl-docs","ref":"calicoctl-docs","sha":"4ac852190c77092bd8da8d9db23e5e99519a6ee3","user":{"login":"TrimBiggs","id":1302077,"avatar_url":"https://avatars.githubusercontent.com/u/1302077?v=3","gravatar_id":"","url":"https://api.github.com/users/TrimBiggs","html_url":"https://github.com/TrimBiggs","followers_url":"https://api.github.com/users/TrimBiggs/followers","following_url":"https://api.github.com/users/TrimBiggs/following{/other_user}","gists_url":"https://api.github.com/users/TrimBiggs/gists{/gist_id}","starred_url":"https://api.github.com/users/TrimBiggs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TrimBiggs/subscriptions","organizations_url":"https://api.github.com/users/TrimBiggs/orgs","repos_url":"https://api.github.com/users/TrimBiggs/repos","events_url":"https://api.github.com/users/TrimBiggs/events{/privacy}","received_events_url":"https://api.github.com/users/TrimBiggs/received_events","type":"User","site_admin":false},"repo":{"id":38397840,"name":"calico-docker","full_name":"TrimBiggs/calico-docker","owner":{"login":"TrimBiggs","id":1302077,"avatar_url":"https://avatars.githubusercontent.com/u/1302077?v=3","gravatar_id":"","url":"https://api.github.com/users/TrimBiggs","html_url":"https://github.com/TrimBiggs","followers_url":"https://api.github.com/users/TrimBiggs/followers","following_url":"https://api.github.com/users/TrimBiggs/following{/other_user}","gists_url":"https://api.github.com/users/TrimBiggs/gists{/gist_id}","starred_url":"https://api.github.com/users/TrimBiggs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TrimBiggs/subscriptions","organizations_url":"https://api.github.com/users/TrimBiggs/orgs","repos_url":"https://api.github.com/users/TrimBiggs/repos","events_url":"https://api.github.com/users/TrimBiggs/events{/privacy}","received_events_url":"https://api.github.com/users/TrimBiggs/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/TrimBiggs/calico-docker","description":"Docker version of Project Calico","fork":true,"url":"https://api.github.com/repos/TrimBiggs/calico-docker","forks_url":"https://api.github.com/repos/TrimBiggs/calico-docker/forks","keys_url":"https://api.github.com/repos/TrimBiggs/calico-docker/keys{/key_id}","collaborators_url":"https://api.github.com/repos/TrimBiggs/calico-docker/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/TrimBiggs/calico-docker/teams","hooks_url":"https://api.github.com/repos/TrimBiggs/calico-docker/hooks","issue_events_url":"https://api.github.com/repos/TrimBiggs/calico-docker/issues/events{/number}","events_url":"https://api.github.com/repos/TrimBiggs/calico-docker/events","assignees_url":"https://api.github.com/repos/TrimBiggs/calico-docker/assignees{/user}","branches_url":"https://api.github.com/repos/TrimBiggs/calico-docker/branches{/branch}","tags_url":"https://api.github.com/repos/TrimBiggs/calico-docker/tags","blobs_url":"https://api.github.com/repos/TrimBiggs/calico-docker/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/TrimBiggs/calico-docker/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/TrimBiggs/calico-docker/git/refs{/sha}","trees_url":"https://api.github.com/repos/TrimBiggs/calico-docker/git/trees{/sha}","statuses_url":"https://api.github.com/repos/TrimBiggs/calico-docker/statuses/{sha}","languages_url":"https://api.github.com/repos/TrimBiggs/calico-docker/languages","stargazers_url":"https://api.github.com/repos/TrimBiggs/calico-docker/stargazers","contributors_url":"https://api.github.com/repos/TrimBiggs/calico-docker/contributors","subscribers_url":"https://api.github.com/repos/TrimBiggs/calico-docker/subscribers","subscription_url":"https://api.github.com/repos/TrimBiggs/calico-docker/subscription","commits_url":"https://api.github.com/repos/TrimBiggs/calico-docker/commits{/sha}","git_commits_url":"https://api.github.com/repos/TrimBiggs/calico-docker/git/commits{/sha}","comments_url":"https://api.github.com/repos/TrimBiggs/calico-docker/comments{/number}","issue_comment_url":"https://api.github.com/repos/TrimBiggs/calico-docker/issues/comments{/number}","contents_url":"https://api.github.com/repos/TrimBiggs/calico-docker/contents/{+path}","compare_url":"https://api.github.com/repos/TrimBiggs/calico-docker/compare/{base}...{head}","merges_url":"https://api.github.com/repos/TrimBiggs/calico-docker/merges","archive_url":"https://api.github.com/repos/TrimBiggs/calico-docker/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/TrimBiggs/calico-docker/downloads","issues_url":"https://api.github.com/repos/TrimBiggs/calico-docker/issues{/number}","pulls_url":"https://api.github.com/repos/TrimBiggs/calico-docker/pulls{/number}","milestones_url":"https://api.github.com/repos/TrimBiggs/calico-docker/milestones{/number}","notifications_url":"https://api.github.com/repos/TrimBiggs/calico-docker/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/TrimBiggs/calico-docker/labels{/name}","releases_url":"https://api.github.com/repos/TrimBiggs/calico-docker/releases{/id}","created_at":"2015-07-01T22:16:32Z","updated_at":"2015-07-01T22:16:32Z","pushed_at":"2015-10-22T18:12:20Z","git_url":"git://github.com/TrimBiggs/calico-docker.git","ssh_url":"git@github.com:TrimBiggs/calico-docker.git","clone_url":"https://github.com/TrimBiggs/calico-docker.git","svn_url":"https://github.com/TrimBiggs/calico-docker","homepage":"http://www.projectcalico.org","size":14215,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"projectcalico:master","ref":"master","sha":"3b215f9dfcf75e047e447fad1e964219ee20fb45","user":{"login":"projectcalico","id":12304728,"avatar_url":"https://avatars.githubusercontent.com/u/12304728?v=3","gravatar_id":"","url":"https://api.github.com/users/projectcalico","html_url":"https://github.com/projectcalico","followers_url":"https://api.github.com/users/projectcalico/followers","following_url":"https://api.github.com/users/projectcalico/following{/other_user}","gists_url":"https://api.github.com/users/projectcalico/gists{/gist_id}","starred_url":"https://api.github.com/users/projectcalico/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/projectcalico/subscriptions","organizations_url":"https://api.github.com/users/projectcalico/orgs","repos_url":"https://api.github.com/users/projectcalico/repos","events_url":"https://api.github.com/users/projectcalico/events{/privacy}","received_events_url":"https://api.github.com/users/projectcalico/received_events","type":"Organization","site_admin":false},"repo":{"id":29629333,"name":"calico-docker","full_name":"projectcalico/calico-docker","owner":{"login":"projectcalico","id":12304728,"avatar_url":"https://avatars.githubusercontent.com/u/12304728?v=3","gravatar_id":"","url":"https://api.github.com/users/projectcalico","html_url":"https://github.com/projectcalico","followers_url":"https://api.github.com/users/projectcalico/followers","following_url":"https://api.github.com/users/projectcalico/following{/other_user}","gists_url":"https://api.github.com/users/projectcalico/gists{/gist_id}","starred_url":"https://api.github.com/users/projectcalico/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/projectcalico/subscriptions","organizations_url":"https://api.github.com/users/projectcalico/orgs","repos_url":"https://api.github.com/users/projectcalico/repos","events_url":"https://api.github.com/users/projectcalico/events{/privacy}","received_events_url":"https://api.github.com/users/projectcalico/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/projectcalico/calico-docker","description":"Project Calico deployed in a Docker container","fork":false,"url":"https://api.github.com/repos/projectcalico/calico-docker","forks_url":"https://api.github.com/repos/projectcalico/calico-docker/forks","keys_url":"https://api.github.com/repos/projectcalico/calico-docker/keys{/key_id}","collaborators_url":"https://api.github.com/repos/projectcalico/calico-docker/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/projectcalico/calico-docker/teams","hooks_url":"https://api.github.com/repos/projectcalico/calico-docker/hooks","issue_events_url":"https://api.github.com/repos/projectcalico/calico-docker/issues/events{/number}","events_url":"https://api.github.com/repos/projectcalico/calico-docker/events","assignees_url":"https://api.github.com/repos/projectcalico/calico-docker/assignees{/user}","branches_url":"https://api.github.com/repos/projectcalico/calico-docker/branches{/branch}","tags_url":"https://api.github.com/repos/projectcalico/calico-docker/tags","blobs_url":"https://api.github.com/repos/projectcalico/calico-docker/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/projectcalico/calico-docker/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/projectcalico/calico-docker/git/refs{/sha}","trees_url":"https://api.github.com/repos/projectcalico/calico-docker/git/trees{/sha}","statuses_url":"https://api.github.com/repos/projectcalico/calico-docker/statuses/{sha}","languages_url":"https://api.github.com/repos/projectcalico/calico-docker/languages","stargazers_url":"https://api.github.com/repos/projectcalico/calico-docker/stargazers","contributors_url":"https://api.github.com/repos/projectcalico/calico-docker/contributors","subscribers_url":"https://api.github.com/repos/projectcalico/calico-docker/subscribers","subscription_url":"https://api.github.com/repos/projectcalico/calico-docker/subscription","commits_url":"https://api.github.com/repos/projectcalico/calico-docker/commits{/sha}","git_commits_url":"https://api.github.com/repos/projectcalico/calico-docker/git/commits{/sha}","comments_url":"https://api.github.com/repos/projectcalico/calico-docker/comments{/number}","issue_comment_url":"https://api.github.com/repos/projectcalico/calico-docker/issues/comments{/number}","contents_url":"https://api.github.com/repos/projectcalico/calico-docker/contents/{+path}","compare_url":"https://api.github.com/repos/projectcalico/calico-docker/compare/{base}...{head}","merges_url":"https://api.github.com/repos/projectcalico/calico-docker/merges","archive_url":"https://api.github.com/repos/projectcalico/calico-docker/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/projectcalico/calico-docker/downloads","issues_url":"https://api.github.com/repos/projectcalico/calico-docker/issues{/number}","pulls_url":"https://api.github.com/repos/projectcalico/calico-docker/pulls{/number}","milestones_url":"https://api.github.com/repos/projectcalico/calico-docker/milestones{/number}","notifications_url":"https://api.github.com/repos/projectcalico/calico-docker/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/projectcalico/calico-docker/labels{/name}","releases_url":"https://api.github.com/repos/projectcalico/calico-docker/releases{/id}","created_at":"2015-01-21T23:46:47Z","updated_at":"2015-10-22T18:30:19Z","pushed_at":"2015-10-22T22:25:51Z","git_url":"git://github.com/projectcalico/calico-docker.git","ssh_url":"git@github.com:projectcalico/calico-docker.git","clone_url":"https://github.com/projectcalico/calico-docker.git","svn_url":"https://github.com/projectcalico/calico-docker","homepage":"http://www.projectcalico.org","size":18033,"stargazers_count":171,"watchers_count":171,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":34,"mirror_url":null,"open_issues_count":33,"forks":34,"open_issues":33,"watchers":171,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532"},"html":{"href":"https://github.com/projectcalico/calico-docker/pull/532"},"issue":{"href":"https://api.github.com/repos/projectcalico/calico-docker/issues/532"},"comments":{"href":"https://api.github.com/repos/projectcalico/calico-docker/issues/532/comments"},"review_comments":{"href":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532/comments"},"review_comment":{"href":"https://api.github.com/repos/projectcalico/calico-docker/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/projectcalico/calico-docker/pulls/532/commits"},"statuses":{"href":"https://api.github.com/repos/projectcalico/calico-docker/statuses/4ac852190c77092bd8da8d9db23e5e99519a6ee3"}}}}