CLICK Deployment

Deployment Guide

🚧

Did you fill out the checklist?

Make sure you've gathered all the necessary data on our Deployment Readiness Checklist before you begin the process of deploying CLICK.

Now that you've prepared your environment and gathered the necessary information, you're ready to set up SynchroNet CLICKβ„’!

Your CLICK Subscription

Whether you subscribed via the Marketplace or are working directly with SynchroNet, you are the proud new owner of a CLICK subscription. All CLICK subscription management is performed in the SynchroNet Customer Portal. To get started, create or log into your SynchroNet account.

368

The SynchroNet Customer Portal logon screen

AWS Account Linking

πŸ“˜

This step does not apply to customers who did not subscribe to CLICK via the AWS Marketplace, or have already configured another AWS Marketplace subscription in the past.

Once you are logged in and viewing the registration wizard, you may be asked to confirm that you want to continue with your currently logged in account. For the average user, the answer to this question will always be "yes."

The first time you use an AWS Account to subscribe to a SynchroNet product or service, we must create a link between that AWS Account and your SynchroNet account. Once the account link is created, any future subscriptions from the same AWS Account will automatically be linked to your SynchroNet account.

1110

SynchroNet account linking page

End User License Agreement (EULA)

As part of every subscription, customers are required to read and accept the SynchroNet CLICK EULA.

1110

EULA Acceptance screen

Company Information

πŸ“˜

Returning customers will not see this step.

If you have just created your SynchroNet account, you will be prompted to provide some basic information about yourself and your company:

  • Company Name
  • Primary Contact Name
  • Primary Contact E-mail (already populated during account creation)
1110

Company Information page

Instance Creation/Selection

Next, you will create or select a CLICK Instance to apply your subscription to.

Create an Instance

You can create a new CLICK instance to apply your subscription to. You will need to name your instance as well as provide some information about the Active Directory environment contained within it. While following the Deployment Readiness Checklist, you should have captured the object GUIDs of three special Active Directory groups that CLICK will use to determine user permissions.

1110

Instance creation form

Select an Instance

If you have an existing Instance whose subscription has expired, you can apply your new subscription to that Instance and get back to using CLICK.

πŸ“˜

You will see all of your CLICK Instances in this list. Any Instances that have an active subscription will appear in green, and you will not be able to select them to apply your new subscription.

1110

Instance selection form

SAML Identity Provider (IdP)

πŸ“˜

If you are applying a subscription to an existing Instance, you will not be required to complete this step.

If you just created a new CLICK instance, you will need to configure federated identity with CLICK by providing information about your SAML IdP. For detailed information about preparing your specific SAML provider, visit our SAML IdP Configuration documentation.

🚧

You may need to wait a couple of minutes for your CLICK Instance to finish being created before you can submit this form.

1110

SAML Identity Provider form

AD Gateway

πŸ“˜

If you are applying a subscription to an existing Instance, you will not be required to complete this step.

If you created a new CLICK instance, you will need to deploy the CLICK AD Gateway into your AWS Account. We provide a CloudFormation Template to simplify this process as much as possible, but the fact remains that Active Directory environments can be fairly complex. After ensuring you have gathered all necessary data on the Deployment Readiness Checklist, follow these steps for a successful AD Gateway deployment.

1110

AD Gateway form

  1. Start at the AD Gateway form pictured above.
  2. In a separate browser tab, ensure you are logged in to the AWS Account where you intend to deploy the AD Gateway (including selecting the desired region), using administrative credentials.
  3. Return to the AD Gateway form and click the Launch Stack button.
    • A new tab will open showing the CloudFormation Quick create stack screen.
1334

Quick create stack screen

  1. Populate the CloudFormation stack parameters. For detailed information about each parameter, see the AD Gateway Stack Parameters page.
  2. Mark the checkbox to accept the creation of IAM resources.
1061

IAM resources dialog

  1. Create the stack.
  2. When the stack is done being created, go to the Output tab and take note of the ClickKMSKeyId value. You are about to create some parameters in the Systems Manager Parameter Store and you will use this key to encrypt them.
1053

Stack outputs screen

  1. Go to the AWS Systems Manager service, enter the Parameter Store section, and click Create Parameter.
1135

AWS Systems Manager Parameter Store screen

  1. The Parameter details form will appear.
818

Parameter details screen

  1. Fill in the following values and create the parameter.
FieldValue
Name/prefix/ad/password
Where "prefix" is the value you specified for the SSMPrefix parameter in the CloudFormation stack.
TypeSecureString
KMS Key IDSelect the value displayed in the CloudFormation stack outputs for SSMKeyId.
ValueThe password for the Active Directory service account you specified in the CloudFormation stack AdUser parameter.
  1. Repeat the above process to create a second parameter with these values.
FieldValue
Name/prefix/shared_secret
TypeSecureString
KMS Key IDSelect the value displayed in the CloudFormation stack outputs for SSMKeyId
ValueCopy this from the AD Gateway screen in the SynchroNet Customer Portal
1058

Shared secret display on the SynchroNet Customer Portal

  1. If you are using Secure LDAP, follow the above steps one last time to create a parameter to store the certificate information for establishing an encrypted LDAP connection.
FieldValue
Name/prefix/ad/cert
TypeSecureString
KMS Key IDSelect the value displayed in the CloudFormation stack outputs for SSMKeyId
ValuePaste the public key value of your certificate, including the -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- lines
  1. Return to the CloudFormation stack outputs screen and copy the values for CrossAccountRoleArn and LambdaFunctionName back to the appropriate fields in the SychroNet Customer Portal.
  2. Before clicking Save and Continue, be sure to select from the dropdown the region into which you deployed your AD Gateway stack.

Review and Launch

At this point, all of your configuration is done. The SynchroNet Customer Portal will display a list of the components you have configured. Once any pending operations on your Instance components complete, you can launch your CLICK Instance.

We hope you find SynchroNet CLICKβ„’ a joy to use!