{"action":"created","issue":{"url":"https://api.github.com/repos/vmware/vic/issues/2073","repository_url":"https://api.github.com/repos/vmware/vic","labels_url":"https://api.github.com/repos/vmware/vic/issues/2073/labels{/name}","comments_url":"https://api.github.com/repos/vmware/vic/issues/2073/comments","events_url":"https://api.github.com/repos/vmware/vic/issues/2073/events","html_url":"https://github.com/vmware/vic/issues/2073","id":172402795,"number":2073,"title":"Document when vic-machine option values need to be escaped","user":{"login":"stuclem","id":16718369,"avatar_url":"https://avatars.githubusercontent.com/u/16718369?v=3","gravatar_id":"","url":"https://api.github.com/users/stuclem","html_url":"https://github.com/stuclem","followers_url":"https://api.github.com/users/stuclem/followers","following_url":"https://api.github.com/users/stuclem/following{/other_user}","gists_url":"https://api.github.com/users/stuclem/gists{/gist_id}","starred_url":"https://api.github.com/users/stuclem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stuclem/subscriptions","organizations_url":"https://api.github.com/users/stuclem/orgs","repos_url":"https://api.github.com/users/stuclem/repos","events_url":"https://api.github.com/users/stuclem/events{/privacy}","received_events_url":"https://api.github.com/users/stuclem/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/vmware/vic/labels/kind/user-doc","name":"kind/user-doc","color":"c5def5"}],"state":"open","locked":false,"assignee":{"login":"stuclem","id":16718369,"avatar_url":"https://avatars.githubusercontent.com/u/16718369?v=3","gravatar_id":"","url":"https://api.github.com/users/stuclem","html_url":"https://github.com/stuclem","followers_url":"https://api.github.com/users/stuclem/followers","following_url":"https://api.github.com/users/stuclem/following{/other_user}","gists_url":"https://api.github.com/users/stuclem/gists{/gist_id}","starred_url":"https://api.github.com/users/stuclem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stuclem/subscriptions","organizations_url":"https://api.github.com/users/stuclem/orgs","repos_url":"https://api.github.com/users/stuclem/repos","events_url":"https://api.github.com/users/stuclem/events{/privacy}","received_events_url":"https://api.github.com/users/stuclem/received_events","type":"User","site_admin":false},"assignees":[{"login":"stuclem","id":16718369,"avatar_url":"https://avatars.githubusercontent.com/u/16718369?v=3","gravatar_id":"","url":"https://api.github.com/users/stuclem","html_url":"https://github.com/stuclem","followers_url":"https://api.github.com/users/stuclem/followers","following_url":"https://api.github.com/users/stuclem/following{/other_user}","gists_url":"https://api.github.com/users/stuclem/gists{/gist_id}","starred_url":"https://api.github.com/users/stuclem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stuclem/subscriptions","organizations_url":"https://api.github.com/users/stuclem/orgs","repos_url":"https://api.github.com/users/stuclem/repos","events_url":"https://api.github.com/users/stuclem/events{/privacy}","received_events_url":"https://api.github.com/users/stuclem/received_events","type":"User","site_admin":false}],"milestone":{"url":"https://api.github.com/repos/vmware/vic/milestones/40","html_url":"https://github.com/vmware/vic/milestones/Doc%20for%20GA","labels_url":"https://api.github.com/repos/vmware/vic/milestones/40/labels","id":1807578,"number":40,"title":"Doc for GA","description":"This milestone is for all doc issues that must be completed by GA.","creator":{"login":"stuclem","id":16718369,"avatar_url":"https://avatars.githubusercontent.com/u/16718369?v=3","gravatar_id":"","url":"https://api.github.com/users/stuclem","html_url":"https://github.com/stuclem","followers_url":"https://api.github.com/users/stuclem/followers","following_url":"https://api.github.com/users/stuclem/following{/other_user}","gists_url":"https://api.github.com/users/stuclem/gists{/gist_id}","starred_url":"https://api.github.com/users/stuclem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stuclem/subscriptions","organizations_url":"https://api.github.com/users/stuclem/orgs","repos_url":"https://api.github.com/users/stuclem/repos","events_url":"https://api.github.com/users/stuclem/events{/privacy}","received_events_url":"https://api.github.com/users/stuclem/received_events","type":"User","site_admin":false},"open_issues":89,"closed_issues":20,"state":"open","created_at":"2016-06-03T17:08:19Z","updated_at":"2016-08-22T10:33:15Z","due_on":"2016-10-21T00:00:00Z","closed_at":null},"comments":1,"created_at":"2016-08-22T09:10:34Z","updated_at":"2016-08-22T16:11:12Z","closed_at":null,"body":"Per this [SocialCast posting](https://vmware-com.socialcast.com/messages/31466650), clarify when you need to escape the values for all `vic-machine` options. We currently state that usernames and passwords need to be escaped if they contain special characters and that datastore names and paths support hyphen and underscores, but not other characters. \r\n\r\nHowever, we also need to mention the following:\r\n\r\n- Hyphens and underscores are permitted in other options (so far have confirmed this for the networking and compute resource options, will check the rest)\r\n- Values with spaces must always be escaped\r\n- Values with characters other than hyphens and underscores need to be escaped\r\n"},"comment":{"url":"https://api.github.com/repos/vmware/vic/issues/comments/241464330","html_url":"https://github.com/vmware/vic/issues/2073#issuecomment-241464330","issue_url":"https://api.github.com/repos/vmware/vic/issues/2073","id":241464330,"user":{"login":"stuclem","id":16718369,"avatar_url":"https://avatars.githubusercontent.com/u/16718369?v=3","gravatar_id":"","url":"https://api.github.com/users/stuclem","html_url":"https://github.com/stuclem","followers_url":"https://api.github.com/users/stuclem/followers","following_url":"https://api.github.com/users/stuclem/following{/other_user}","gists_url":"https://api.github.com/users/stuclem/gists{/gist_id}","starred_url":"https://api.github.com/users/stuclem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stuclem/subscriptions","organizations_url":"https://api.github.com/users/stuclem/orgs","repos_url":"https://api.github.com/users/stuclem/repos","events_url":"https://api.github.com/users/stuclem/events{/privacy}","received_events_url":"https://api.github.com/users/stuclem/received_events","type":"User","site_admin":false},"created_at":"2016-08-22T16:11:12Z","updated_at":"2016-08-22T16:11:12Z","body":"I have updated the following doc topics to describe when to wrap options in quotes:\r\n- [Virtual Container Host Deployment Options](https://github.com/stuclem/vic/blob/master/doc/user_doc/vic_installation/vch_installer_options.md)\r\n- [Virtual Container Host Inspect Options](https://github.com/stuclem/vic/blob/master/doc/user_doc/vic_admin/inspect_vch_options.md)\r\n- [Virtual Container Host Delete Options](https://github.com/stuclem/vic/blob/master/doc/user_doc/vic_admin/delete_vch_options.md)\r\n- [Virtual Container Host List Options](https://github.com/stuclem/vic/blob/master/doc/user_doc/vic_admin/list_vch_options.md)\r\n- [VCH Deployment Fails with Unknown or Non-Specified Argument Error or Incorrect User Name Error](https://github.com/stuclem/vic/blob/master/doc/user_doc/vic_installation/ts_cli_argument_error.md) (new)\r\n\r\n@emlin and @gigawhitlocks, does this cover it? The best thing to do is to do a CTRL-F for \"quot\" in each topic, since this issue affects all options that take a string as their argument. "}}
{"actor":{"display_login":"stuclem"}}