From 61a85c823d4a6e31368338ec661f6655523007fe Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 14:33:57 -0400 Subject: [PATCH 1/9] Add documentation of 'scan' type to job type popover. (c.f. #2293) --- awx/ui/client/src/forms/JobTemplates.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/awx/ui/client/src/forms/JobTemplates.js b/awx/ui/client/src/forms/JobTemplates.js index 2751a50f13..dbe8a31aab 100644 --- a/awx/ui/client/src/forms/JobTemplates.js +++ b/awx/ui/client/src/forms/JobTemplates.js @@ -46,8 +46,9 @@ export default editRequired: true, column: 1, awPopOver: "

When this template is submitted as a job, setting the type to run will execute the playbook, running tasks " + - " on the selected hosts.

Setting the type to check will not execute the playbook. Instead, ansible will check playbook " + - " syntax, test environment setup and report problems.

", + " on the selected hosts.

Setting the type to check will not execute the playbook. Instead, ansible will check playbook " + + " syntax, test environment setup and report problems.

Setting the type to scan will execute the playbook and store any " + + " scanned facts for use with Tower's System Tracking feature.

", dataTitle: 'Job Type', dataPlacement: 'right', dataContainer: "body", From af1fac3b1d167e8a55ad49fcca171d45f67f4624 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 14:38:46 -0400 Subject: [PATCH 2/9] Update label popover help. (re: #2293) --- awx/ui/client/src/forms/JobTemplates.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awx/ui/client/src/forms/JobTemplates.js b/awx/ui/client/src/forms/JobTemplates.js index dbe8a31aab..2441f567fa 100644 --- a/awx/ui/client/src/forms/JobTemplates.js +++ b/awx/ui/client/src/forms/JobTemplates.js @@ -286,7 +286,7 @@ export default editRequired: false, dataTitle: 'Labels', dataPlacement: 'right', - awPopOver: 'You can add labels to a job template to aid in filtering', + awPopOver: "

Optional labels that describe this job template, such as 'dev' or 'test'. Labels can be used to group and filter job templates and completed jobs in the Tower display.

", dataContainer: 'body' }, variables: { From d136ee8f26d95c41140bfbcf9ca4e8ec7dcec1c4 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 14:49:10 -0400 Subject: [PATCH 3/9] Standardize around 'ansible-playbook' and arguments. --- awx/ui/client/src/forms/JobTemplates.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/awx/ui/client/src/forms/JobTemplates.js b/awx/ui/client/src/forms/JobTemplates.js index 2441f567fa..78547e2328 100644 --- a/awx/ui/client/src/forms/JobTemplates.js +++ b/awx/ui/client/src/forms/JobTemplates.js @@ -231,7 +231,7 @@ export default addRequired: false, editRequird: false, column: 2, - awPopOver: "

If enabled, run this playbook as an administrator. This is the equivalent of passing the --become option to the ansible-playbook command.

", + awPopOver: "

If enabled, run this playbook as an administrator. This is the equivalent of passing the --become option to the ansible-playbook command.

", dataPlacement: 'right', dataTitle: 'Become Privilege Escalation', dataContainer: "body" @@ -298,8 +298,8 @@ export default editRequired: false, "default": "---", column: 2, - awPopOver: "

Pass extra command line variables to the playbook. This is the -e or --extra-vars command line parameter " + - "for ansible-playbook. Provide key/value pairs using either YAML or JSON.

" + + awPopOver: "

Pass extra command line variables to the playbook. This is the -e or --extra-vars command line parameter " + + "for ansible-playbook. Provide key/value pairs using either YAML or JSON.

" + "JSON:
\n" + "
{
 \"somevar\": \"somevalue\",
 \"password\": \"magic\"
}
\n" + "YAML:
\n" + From 5fea2829548467dd5b5c6f8a7d3f1ab35ec285f8 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 14:51:51 -0400 Subject: [PATCH 4/9] Add 'Tag None' help to AWS 'Only Group By' popover. re: #2291 --- awx/ui/client/src/forms/Groups.js | 1 + 1 file changed, 1 insertion(+) diff --git a/awx/ui/client/src/forms/Groups.js b/awx/ui/client/src/forms/Groups.js index 49527df717..47950103f6 100644 --- a/awx/ui/client/src/forms/Groups.js +++ b/awx/ui/client/src/forms/Groups.js @@ -134,6 +134,7 @@ export default "
  • Security Group: security_groups » security_group_default
    • " + "
  • Tags: tags » tag_Name » tag_Name_host1
    • " + "
  • VPC ID: vpcs » vpc-5ca1ab1e
    • " + + "
  • Tag None: tags » tag_none
    • " + "

    If blank, all groups above are created except Instance ID.

    ", dataContainer: 'body' }, From 6a0ef366f3f4dde005c55152a189bfb0805340d8 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 15:06:58 -0400 Subject: [PATCH 5/9] Tweak wording on custom inventory script Environment variables popover to describe environment vars. Also use the standard JSON/YAML verbiage (this should be a constant somewhere). re: #2290 --- awx/ui/client/src/forms/Groups.js | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/awx/ui/client/src/forms/Groups.js b/awx/ui/client/src/forms/Groups.js index 47950103f6..9a42ad6218 100644 --- a/awx/ui/client/src/forms/Groups.js +++ b/awx/ui/client/src/forms/Groups.js @@ -162,11 +162,14 @@ export default parseTypeName: 'envParseType', dataTitle: "Environment Variables", dataPlacement: 'right', - awPopOver: "

    Provide key/value pairs using either YAML or JSON.

    " + + awPopOver: "

    Provide environment variables to pass to the custom inventory script.

    " + + "

    Enter variables using either JSON or YAML syntax. Use the radio button to toggle between the two.

    " + "JSON:
    \n" + "
    {
     \"somevar\": \"somevalue\",
     \"password\": \"magic\"
    }
    \n" + "YAML:
    \n" + - "
    ---
    somevar: somevalue
    password: magic
    \n", + "
    ---
    somevar: somevalue
    password: magic
    \n" + + '

    View JSON examples at www.json.org

    ' + + '

    View YAML examples at docs.ansible.com

    ', dataContainer: 'body' }, ec2_variables: { From 2068665c4e20b51f964952ab1f28f86aa248b666 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 15:35:35 -0400 Subject: [PATCH 6/9] Fix Twilio popover help. re: #2272 --- .../client/src/notifications/notificationTemplates.form.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/awx/ui/client/src/notifications/notificationTemplates.form.js b/awx/ui/client/src/notifications/notificationTemplates.form.js index 0a4b2d5499..4b8038023d 100644 --- a/awx/ui/client/src/notifications/notificationTemplates.form.js +++ b/awx/ui/client/src/notifications/notificationTemplates.form.js @@ -185,6 +185,8 @@ export default function() { from_number: { label: 'Source Phone Number', type: 'text', + awPopOver: '

    Number associated with the "Messaging Service" in Twilio.

    '+ + '

    This must be of the form +18005550199.

    ', awRequiredWhen: { reqExpression: "twilio_required", init: "false" @@ -197,8 +199,8 @@ export default function() { type: 'textarea', rows: 3, awPopOver: '

    Type an option on each line.

    '+ - '

    For example:
    alias1@email.com
    \n alias2@email.com
    \n', - dataTitle: 'Destination Channels', + '

    For example:
    +12125552368
    \n+19105556162
    \n', + dataTitle: 'Destination SMS Number', dataPlacement: 'right', dataContainer: "body", awRequiredWhen: { From bcdc17dc06ca6e46309a7a8be6adbaa332412660 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 15:40:53 -0400 Subject: [PATCH 7/9] Drop key hints, as they are redundant with the popovers. re: #2249 --- awx/ui/client/src/forms/Credentials.js | 1 - awx/ui/client/src/helpers/Credentials.js | 4 ---- 2 files changed, 5 deletions(-) diff --git a/awx/ui/client/src/forms/Credentials.js b/awx/ui/client/src/forms/Credentials.js index 92642bf239..24ca35acd2 100644 --- a/awx/ui/client/src/forms/Credentials.js +++ b/awx/ui/client/src/forms/Credentials.js @@ -239,7 +239,6 @@ export default }, class: 'Form-textAreaLabel Form-formGroup--fullWidth', elementClass: 'Form-monospace', - hintText: "{{ key_hint }}", addRequired: false, editRequired: false, awDropFile: true, diff --git a/awx/ui/client/src/helpers/Credentials.js b/awx/ui/client/src/helpers/Credentials.js index f9960e550e..81037560e2 100644 --- a/awx/ui/client/src/helpers/Credentials.js +++ b/awx/ui/client/src/helpers/Credentials.js @@ -39,7 +39,6 @@ angular.module('CredentialsHelper', ['Utilities']) scope.project_required = false; scope.subscription_required = false; scope.key_description = "Paste the contents of the SSH private key file.

    esc or click to close
    "; - scope.key_hint= "paste or drag and drop an SSH private key file on the field below"; scope.host_required = false; scope.password_required = false; scope.hostLabel = ''; @@ -65,7 +64,6 @@ angular.module('CredentialsHelper', ['Utilities']) scope.domain_required = false; scope.subscription_required = false; scope.key_description = "Paste the contents of the SSH private key file."; - scope.key_hint= "paste or drag and drop an SSH private key file on the field below"; scope.host_required = false; scope.password_required = false; scope.hostLabel = ''; @@ -101,7 +99,6 @@ angular.module('CredentialsHelper', ['Utilities']) scope.key_required = true; scope.project_required = true; scope.key_description = 'Paste the contents of the PEM file associated with the service account email.'; - scope.key_hint= "drag and drop a private key file on the field below"; scope.projectLabel = "Project"; scope.project_required = false; scope.projectPopOver = "

    The Project ID is the " + @@ -114,7 +111,6 @@ angular.module('CredentialsHelper', ['Utilities']) scope.subscription_required = true; scope.key_required = true; scope.key_description = "Paste the contents of the PEM file that corresponds to the certificate you uploaded in the Microsoft Azure console."; - scope.key_hint= "drag and drop a management certificate file on the field below"; break; case 'azure_rm': scope.usernameLabel = "Username"; From 9a1bcb3384ad433037a39a5fd6d7f9210651ee68 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 15:49:01 -0400 Subject: [PATCH 8/9] Update Credential popover help for network credentials, add some more verbiage to the 'Other' section. re: #2252 --- awx/ui/client/src/forms/Credentials.js | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/awx/ui/client/src/forms/Credentials.js b/awx/ui/client/src/forms/Credentials.js index 24ca35acd2..f81a999fab 100644 --- a/awx/ui/client/src/forms/Credentials.js +++ b/awx/ui/client/src/forms/Credentials.js @@ -67,14 +67,18 @@ export default '

    Authentication for remote machine access. This can include SSH keys, usernames, passwords, ' + 'and sudo information. Machine credentials are used when submitting jobs to run playbooks against ' + 'remote hosts.
    ' + + '
    Network
    \n' + + '
    Authentication for network device access. This can include SSH keys, usernames, passwords, ' + + 'and authorize information. Network credentials are used when submitting jobs to run playbooks against ' + + 'network devices.
    ' + '
    Source Control
    \n' + '
    Used to check out and synchronize playbook repositories with a remote source control ' + 'management system such as Git, Subversion (svn), or Mercurial (hg). These credentials are ' + - 'used on the Projects tab.
    \n' + + 'used by Projects.\n' + '
    Others (Cloud Providers)
    \n' + - '
    Access keys for authenticating to the specific ' + - 'cloud provider, usually used for inventory sync ' + - 'and deployment.
    \n' + + '
    Usernames, passwords, and access keys for authenticating to the specified cloud or infrastructure ' + + 'provider. These are used for dynamic inventory sources and for cloud provisioning and deployment ' + + 'in playbook runs.
    \n' + '\n', dataTitle: 'Type', dataPlacement: 'right', From cb80702e4af542e6bc2cb2077123b7f9204acc48 Mon Sep 17 00:00:00 2001 From: Bill Nottingham Date: Fri, 10 Jun 2016 15:54:47 -0400 Subject: [PATCH 9/9] Add examples for HipChat 'color' field. re: #2271 --- awx/ui/client/src/notifications/notificationTemplates.form.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/awx/ui/client/src/notifications/notificationTemplates.form.js b/awx/ui/client/src/notifications/notificationTemplates.form.js index 4b8038023d..a49c7a126b 100644 --- a/awx/ui/client/src/notifications/notificationTemplates.form.js +++ b/awx/ui/client/src/notifications/notificationTemplates.form.js @@ -274,6 +274,8 @@ export default function() { color: { label: 'Notification Color', type: 'text', + awPopOver: '

    Color can be one of yellow, green, red, ' + + 'purple, gray, or random.\n', awRequiredWhen: { reqExpression: "hipchat_required", init: "false"