access testing tool installation guide · access testing tool, part of native hybrid cloud, enables...

Installation Guide

Access Testing ToolVersion 1.2.1

Access Testing Tool Installation Guide302-003-612REV 01January 2017

This installation guide contains information about installing Access Testing Tool. Topicsinclude:

l About Access Testing Tool..................................................................................... 2l Obtaining the installation files.................................................................................3l Command conventions........................................................................................... 3l Creating a UAAC client........................................................................................... 3l Creating an organization and a space..................................................................... 5l Adding a MySQL service instance...........................................................................6l Configuring the manifest........................................................................................ 6l Pushing Access Testing Tool.................................................................................. 7l Creating a Pivotal Cloud Foundry user....................................................................8l Installing the Access Testing Tool CLI.....................................................................8l Logging in to Access Testing Tool.......................................................................... 9l Revision history.....................................................................................................10l About this document............................................................................................. 10l About Access Testing Tool.................................................................................... 10l Obtaining the installation files................................................................................ 11l Creating a UAAC client..........................................................................................12l Configuring the manifest....................................................................................... 14l Creating an organization and a space.................................................................... 15l Adding a MySQL service instance......................................................................... 15l Pushing Access Testing Tool................................................................................. 15l Creating a Pivotal Cloud Foundry user.................................................................. 16l Logging in to Access Testing Tool......................................................................... 16

About Access Testing Tool

Access Testing Tool, part of Native Hybrid Cloud, enables developers to migratetraditional applications to a cloud-native framework in Pivotal Cloud Foundry. NativeHybrid Cloud includes a robust set of tools designed to enhance the capabilities ofdevelopers who build applications in Pivotal Cloud Foundry.

Access Testing Tool enables organizations to accelerate migrating traditionalapplications into cloud-native frameworks. This process involves rebuilding portions ofthe application as microservices, until the entire application is completely separatedinto flexible, easily upgraded components. Access Testing Tool streamlines thisprocess. It enables developers to quickly test the application’s dependencies onenterprise data services and systems of record, and determine whether the applicationhas access to those services and systems. In minutes, developers can validatewhether an application is ready for a Pivotal Cloud Foundry environment.

The Access Testing Tool architecture is shown in the figure below.

Figure 1 Access Testing Tool architecture diagram

Installation Guide

2 Access Testing Tool 1.2.1 Installation Guide

Obtaining the installation files

Before you begin

You must have the following:

l A Pivotal Cloud Foundry Elastic Runtime User account

l A Cloud Foundry Command Line Interface (cf CLI) installation that can connect tothe target Pivotal Cloud Foundry environment. See Installing the cf CLI for moreinformation.

Procedure

1. Contact EMC Professional Services or your account team to obtain theinstallation files.

The files are:

l manifest.ymll access-testing-tool.jar

2. Use an FTP client to upload the files to your cf CLI server.

Command conventions

Some commands use parameters. The parameters are denoted by angle brackets, likethis:

command <parameter>

Creating a UAAC clientUse the procedure below to create a User Account and Authentication CLI (UAAC)client named nhc-nessie.

Refer to Creating and Managing Users with the UAA CLI (UAAC) on the Pivotalwebsite for more information about adding clients in the User Account andAuthentication (UAA) server.

Procedure

1. Log in to your cf CLI server.

2. Follow the instructions in Creating and Managing Users with the UAA CLI(UAAC) to install cf-uaac.

3. Type the following command to target the UAA system domain:

uaac target https://<Pivotal Cloud Foundry target URL> --skip-ssl-validation

For example, specify the URL https://uaa.<pcf-system_domain> as the target.

4. Retrieve the UAA Admin Client password from the Pivotal Cloud FoundryOperations Manager user interface.

Access Testing Tool Installation Guide

Obtaining the installation files 3

http://docs.pivotal.io/pivotalcf/1-8/cf-cli/install-go-cli.html

http://docs.pivotal.io/pivotalcf/1-9/adminguide/uaa-user-management.html



a. Select the Pivotal Elastic Runtime tile.

b. Select the Credentials tab.

c. Scroll down to UAA.

d. Select the Admin Client Credentials link to view the password.

5. Type the following command to request a UAA token:

uaac token client get admin -s <UAA admin client password>

6. Type the following command to create the nhc-nessie user:

uaac client add nhc-nessie --authorized_grant_types "refresh_token password client_credentials authorization_code"

Note

The client name nhc-nessie is a constant value. Do not use another value.

7. Type password as the secret for the nhc-nessie client.

Note

The nhc-nessie client secret is fixed and preconfigured as password. Youmust type password for the secret.

8. Type the following command to change the scope of the nhc-nessie user:

uaac client update nhc-nessie --scope "cloud_controller.read password.write cloud_controller.write openid doppler.firehose scim.write scim.read cloud_controller.admin uaa.user"

9. Type the following command to assign a redirect URI to the nhc-nessie user:

uaac client update nhc-nessie --redirect_uri "https://<att-app-name>.<pcf-apps-domain>/ http://<att-app-name>.<pcf-apps-domain>/"

The redirect_uri URL must be the route used by Access Testing Tool. Includethe secure (https) and regular (http) URLs and the closing forward slash (/).You can leave the redirect_uri field empty and update it after you push AccessTesting Tool to the Pivotal Cloud Foundry workspace.

Note

The redirect_uri URL, including the closing forward slash (/), must match theURL in the uaa.logout.redirect field in manifest.yml. Only the secure (https)URL is used in manifest.yml.

Installation Guide


10. Type the following command to update the authorities list for nhc-nessieuser:

uaac client update nhc-nessie --authorities "uaa.admin scim.read scim.write zones.uaa.admin cloud_controller.admin cloud_controller.read cloud_controller.write"

11. Type the following command to verify that the UAAC client is added:

uaac client get nhc-nessie

The following output shows a successfully added UAAC client.

scope: cloud_controller.read password.write cloud_controller.write openid doppler.firehose scim.write scim.read cloud_controller.admin uaa.user client_id: nhc-nessie resource_ids: none authorized_grant_types: refresh_token password client_credentials authorization_code redirect_uri: https://nhc-gui-app.apps.pcf.domain/ http://nhc-gui-app.apps.pcf.domain/ autoapprove: action: none authorities: uaa.none name: nhc-nessie lastmodified: 1479884377000

Creating an organization and a spaceYou must create an organization and a space in that organization before you can pushAccess Testing Tool.

See Cloud Foundry CLI Reference Guide on the Pivotal website for cf CLI help.

Procedure

1. Type the following cf CLI command to create an organization named nhc-gui:

cf create-org nhc-gui

2. Type the following cf CLI command to create a space called development in thenew organization:

cf create-space development -o nhc-gui


Creating an organization and a space 5

https://docs.pivotal.io/pivotalcf/1-8/cf-cli/cf-help.html

Adding a MySQL service instance

The target Pivotal Cloud Foundry environment must have MySQL installed. See MySQL for Pivotal Cloud Foundry: Installation on the Pivotal website for installationinstructions. Access Testing Tool supports MySQL version 1.8 and higher.

Import the MySQL product into Pivotal Cloud Foundry Operations Manager so thatthe nhc-gui_db field defined in the manifest.yml file can bind to the MySQLservice.

Configure the MySQL service instance with the relevant information, including theinstance name nhc-gui_db. See MySQL for Pivotal Cloud Foundry: Service Plans forinstructions.

Add a MySQL service in Pivotal Apps Manager

Procedure

1. Use the UAA Admin account to log in to Pivotal Apps Manager.

The Pivotal Apps Manager URL is https://apps.<pcf-system-domain>.

To retrieve the Pivotal Apps Manager user credentials, in Pivotal Cloud Foundryclick the Elastic Runtime tile and go to Credentials tab > UAA > AdminCredentials/Link to Credentials.

2. Under Org, select nhc-gui.

3. Under Spaces, select development.

4. Select the Services tab, and then click Add Service.

5. Select Mysql, and then click Select this plan.

6. Type the instance name nhc-gui_db, and then click Add.

Results

The MySQL service is added to the development space in Pivotal Apps Manager.

Configuring the manifestDefine the fields in the manifest.yml file.

Procedure

1. Open the manifest.yml file and edit the following fields:

name

The name of your Access Testing Tool application in your Pivotal CloudFoundry environment

path

The path to the access-testing-tool-1.3.0.jar file on your cf CLIserver

cf.host

The target environment‘s Pivotal Cloud Foundry API host

Installation Guide


http://docs.pivotal.io/p-mysql/1-8/#installation

https://docs.pivotal.io/p-mysql/1-8/#service-plan

pcf.uaa.host

The target environment‘s Pivotal Cloud Foundry UAA host

uaa.logout.redirect

The secure (https) URL that is used in the redirect_uri of UAAC nhc-nessie

Note

Use only the secure (https) URL.

nhc-gui_db

The MySQL service instance nameThe service instance must be created before you push Access Testing Toolto your Pivotal Cloud Foundry workspace. Access Testing Tool needs aMySQL service to use in your target Pivotal Cloud Foundry environment, asdescribed in Adding a MySQL service instance on page 6.

The following is a sample manifest.yml file:

---applications:- name: nhc-gui-app path: /home/username/access-testing-tool-1.3.0.jar env: cf.host: api.<pcf-system-domain> pcf.uaa.host: https://uaa.<pcf-system-domain> uaa.logout.redirect: https://<att-app-name>.<pcf-apps-domain>/ services: - nhc-gui_db

Pushing Access Testing ToolYou must push, or deploy, Access Testing Tool to your Pivotal Cloud Foundryworkspace.

Procedure

1. Type the following command to redirect the cf CLI to the target organizationand space where you are pushing Access Testing Tool.

cf t -o nhc-gui -s development

2. Type the following command to push Access Testing Tool to your Pivotal CloudFoundry workspace.

cf push <att-app-name>


Pushing Access Testing Tool 7

Creating a Pivotal Cloud Foundry userCreate a Pivotal Cloud Foundry user before you log in to Access Testing Tool.

Use cf cli to create users and assign roles.

Procedure

1. Use the following command to create a new user and assign a password.

cf create-user <username> <password>

2. Use the following command to assign this user a role.

cf set-space-role <username> nhc-gui development SpaceDeveloper

The user is assigned a SpaceDeveloper role in space development under thenhc-gui organization.

Installing the Access Testing Tool CLI

The Access Testing Tool CLI is installed as a Pivotal Cloud Foundry plug-in. It enablesyou to run YAML files from a command line.

Procedure


2. Extract att-cli.zip, which contains the Access Testing Tool CLI installationfiles for Windows, Linux, and macOS.

If you need att-cli.zip, see Obtaining the installation files on page 3.

3. Type the following command to install the Access Testing Tool CLI.

cf install-plugin <platform package>

The platform package is the installation package in att-cli.zip for your cfCLI server operating system.

Example command:

cf install-plugin nhc_att_cf_plugin_amd64.exe

Verifying the Access Testing Tool CLI installationUse this procedure to verify that the Access Testing Tool CLI plug-in is installedcorrectly.

Procedure

1. In the cf CLI, type the following command:

cf plugins

Installation Guide


The following response is returned if the installation is successful:

Listing Installed Plugins...OK

Plugin Name Version Command Name Command HelpNHC_AccessTestingTool 1.3.0 nhc-att runs YAML files from the command line for use in a CI/CD pipeline.

2. In the cf CLI, type the following command:

cf nhc-att --helpIf the installation is successful, the command returns the following response:

NAME: nhc-att - runs YAML files from the command line for use in a CI/CD pipeline.

USAGE: cf nhc-att file1.yml file2.yml etc.

Logging in to Access Testing Tool

Procedure

1. Open a web browser and go to the redirect_uri address.

This is the same address as the uaa.logout.redirect field in manifest.yml.

You are redirected to the Pivotal Cloud Foundry login page.

2. Log in as the Pivotal Cloud Foundry user that you created in Creating a PivotalCloud Foundry user on page 8.

You can see that Access Testing Tool is successfully built and published in theNative Hybrid Cloud Developer Portal.


Logging in to Access Testing Tool 9

Figure 2 Native Hybrid Cloud Developer Portal

Revision history

Table 1 Revision history

Revision Date Description

01 January 31, 2017 First release of this document

About this document

This guide contains Access Testing Tool installation instructions.

About Access Testing Tool

Access Testing Tool, part of Native Hybrid Cloud, enables developers to migratetraditional applications to a cloud-native framework in Pivotal Cloud Foundry. NativeHybrid Cloud includes a robust set of tools designed to enhance the capabilities ofdevelopers who build applications in Pivotal Cloud Foundry.

Access Testing Tool enables organizations to accelerate migrating traditionalapplications into cloud-native frameworks. This process involves rebuilding portions ofthe application as microservices, until the entire application is completely separatedinto flexible, easily upgraded components. Access Testing Tool streamlines thisprocess. It enables developers to quickly test the application’s dependencies onenterprise data services and systems of record, and determine whether the application

Installation Guide


has access to those services and systems. In minutes, developers can validatewhether an application is ready for a Pivotal Cloud Foundry environment.

The Access Testing Tool architecture is shown in the figure below.

Figure 3 Access Testing Tool architecture diagram

Obtaining the installation files

Before you begin

You must have the following:

l A Pivotal Cloud Foundry Elastic Runtime User account

l A Cloud Foundry Command Line Interface (cf CLI) installation that can connect tothe target Pivotal Cloud Foundry environment. See Installing the cf CLI for moreinformation.

Procedure

1. Contact EMC Professional Services or your account team to obtain theinstallation files.


Obtaining the installation files 11

http://docs.pivotal.io/pivotalcf/1-8/cf-cli/install-go-cli.html

The files are:

l manifest.ymll access-testing-tool.jar

2. Use an FTP client to upload the files to your cf CLI server.

Creating a UAAC clientUse the procedure below to create a User Account and Authentication CLI (UAAC)client named nhc-nessie.

Refer to Creating and Managing Users with the UAA CLI (UAAC) on the Pivotalwebsite for more information about adding clients in the User Account andAuthentication (UAA) server.

Procedure


2. Follow the instructions in Creating and Managing Users with the UAA CLI(UAAC) to install cf-uaac.

3. Type the following command to target the UAA system domain:

uaac target https://<Pivotal Cloud Foundry target URL> --skip-ssl-validation

For example, specify the URL https://uaa.<pcf-system_domain> as the target.

4. Retrieve the UAA Admin Client password from the Pivotal Cloud FoundryOperations Manager user interface.

a. Select the Pivotal Elastic Runtime tile.

b. Select the Credentials tab.

c. Scroll down to UAA.

d. Select the Admin Client Credentials link to view the password.

5. Type the following command to request a UAA token:

uaac token client get admin -s <UAA admin client password>

6. Type the following command to create the nhc-nessie user:

uaac client add nhc-nessie --authorized_grant_types "refresh_token password client_credentials authorization_code"

Note

The client name nhc-nessie is a constant value. Do not use another value.

7. Type password as the secret for the nhc-nessie client.

Installation Guide





Note

The nhc-nessie client secret is fixed and preconfigured as password. Youmust type password for the secret.

8. Type the following command to change the scope of the nhc-nessie user:

uaac client update nhc-nessie --scope "cloud_controller.read password.write cloud_controller.write openid doppler.firehose scim.write scim.read cloud_controller.admin uaa.user"

9. Type the following command to assign a redirect URI to the nhc-nessie user:

uaac client update nhc-nessie --redirect_uri "https://<att-app-name>.<pcf-apps-domain>/ http://<att-app-name>.<pcf-apps-domain>/"

The redirect_uri URL must be the route used by Access Testing Tool. Includethe secure (https) and regular (http) URLs and the closing forward slash (/).You can leave the redirect_uri field empty and update it after you push AccessTesting Tool to the Pivotal Cloud Foundry workspace.

Note

The redirect_uri URL, including the closing forward slash (/), must match theURL in the uaa.logout.redirect field in manifest.yml. Only the secure (https)URL is used in manifest.yml.

10. Type the following command to update the authorities list for nhc-nessieuser:

uaac client update nhc-nessie --authorities "uaa.admin scim.read scim.write zones.uaa.admin cloud_controller.admin cloud_controller.read cloud_controller.write"

11. Type the following command to verify that the UAAC client is added:

uaac client get nhc-nessie

The following output shows a successfully added UAAC client.

scope: cloud_controller.read password.write cloud_controller.write openid doppler.firehose scim.write scim.read cloud_controller.admin uaa.user client_id: nhc-nessie resource_ids: none authorized_grant_types: refresh_token password client_credentials authorization_code


Creating a UAAC client 13

redirect_uri: https://nhc-gui-app.apps.pcf.domain/ http://nhc-gui-app.apps.pcf.domain/ autoapprove: action: none authorities: uaa.none name: nhc-nessie lastmodified: 1479884377000

Configuring the manifestDefine the fields in the manifest.yml file.

Procedure

1. Open the manifest.yml file and edit the following fields:

name

The name of your Access Testing Tool application in your Pivotal CloudFoundry environment

path

The path to the access-testing-tool-1.3.0.jar file on your cf CLIserver

cf.host

The target environment‘s Pivotal Cloud Foundry API host

pcf.uaa.host

The target environment‘s Pivotal Cloud Foundry UAA host

uaa.logout.redirect

The secure (https) URL that is used in the redirect_uri of UAAC nhc-nessie

Note

Use only the secure (https) URL.

nhc-gui_db

The MySQL service instance nameThe service instance must be created before you push Access Testing Toolto your Pivotal Cloud Foundry workspace. Access Testing Tool needs aMySQL service to use in your target Pivotal Cloud Foundry environment, asdescribed in Adding a MySQL service instance on page 6.

The following is a sample manifest.yml file:

---applications:- name: nhc-gui-app path: /home/username/access-testing-tool-1.3.0.jar

Installation Guide


env: cf.host: api.<pcf-system-domain> pcf.uaa.host: https://uaa.<pcf-system-domain> uaa.logout.redirect: https://<att-app-name>.<pcf-apps-domain>/ services: - nhc-gui_db

Creating an organization and a spaceYou must create an organization and a space in that organization before you can pushAccess Testing Tool.

See Cloud Foundry CLI Reference Guide on the Pivotal website for cf CLI help.

Procedure

1. Type the following cf CLI command to create an organization named nhc-gui:

cf create-org nhc-gui

2. Type the following cf CLI command to create a space called development in thenew organization:

cf create-space development -o nhc-gui

Adding a MySQL service instance

The target Pivotal Cloud Foundry environment must have MySQL installed. See MySQL for Pivotal Cloud Foundry: Installation on the Pivotal website for installationinstructions. Access Testing Tool supports MySQL version 1.8 and higher.

Import the MySQL product into Pivotal Cloud Foundry Operations Manager so thatthe nhc-gui_db field defined in the manifest.yml file can bind to the MySQLservice.

Configure the MySQL service instance with the relevant information, including theinstance name nhc-gui_db. See MySQL for Pivotal Cloud Foundry: Service Plans forinstructions.

Pushing Access Testing ToolYou must push, or deploy, Access Testing Tool to your Pivotal Cloud Foundryworkspace.

Procedure

1. Type the following command to redirect the cf CLI to the target organizationand space where you are pushing Access Testing Tool.

cf t -o nhc-gui -s development


Creating an organization and a space 15

https://docs.pivotal.io/pivotalcf/1-8/cf-cli/cf-help.html

http://docs.pivotal.io/p-mysql/1-8/#installation

https://docs.pivotal.io/p-mysql/1-8/#service-plan

2. Type the following command to push Access Testing Tool to your Pivotal CloudFoundry workspace.

cf push <att-app-name>

Creating a Pivotal Cloud Foundry userCreate a Pivotal Cloud Foundry user before you log in to Access Testing Tool.

Use cf cli to create users and assign roles.

Procedure

1. Use the following command to create a new user and assign a password.

cf create-user <username> <password>

2. Use the following command to assign this user a role.

cf set-space-role <username> nhc-gui development SpaceDeveloper

The user is assigned a SpaceDeveloper role in space development under thenhc-gui organization.

Logging in to Access Testing Tool

Procedure

1. Open a web browser and go to the redirect_uri address.

This is the same address as the uaa.logout.redirect field in manifest.yml.

You are redirected to the Pivotal Cloud Foundry login page.

2. Log in as the Pivotal Cloud Foundry user that you created in Creating a PivotalCloud Foundry user on page 8.

You can see that Access Testing Tool is successfully built and published in theNative Hybrid Cloud Developer Portal.

Installation Guide


Figure 4 Native Hybrid Cloud Developer Portal


Logging in to Access Testing Tool 17

Copyright © 2017 Dell Inc. or its subsidiaries. All rights reserved.

Published January 2017

Dell believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS-IS.“ DELL MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH

RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR

FITNESS FOR A PARTICULAR PURPOSE. USE, COPYING, AND DISTRIBUTION OF ANY DELL SOFTWARE DESCRIBED IN THIS PUBLICATION

REQUIRES AN APPLICABLE SOFTWARE LICENSE.

Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property of their respective owners.

Published in the USA.

Installation Guide


access testing tool installation guide · access testing tool, part of native hybrid cloud, enables...

Documents