Predix Cloud Cache © 2020 General Electric Company Contents Chapter 1: Overview 1 Overview of Predix Cloud Cache 2 Predix Cloud Cache Architecture 2 Chapter 2: Configuring Predix Cloud Cache Service 3 Configure Predix Cloud Cache Service 4 Create Predix Cloud Cache Service Instance 4 Bind the Cloud Foundry Application to the Predix Cloud Cache Service Instance 6 Update Predix Cloud Cache Service Instance 7 Unbind the Predix Cloud Cache Service Instance from the Cloud Foundry Application 7 Delete Predix Cloud Cache Service Instance 8 Chapter 3: Using Predix Cloud Cache Service 9 Connect to Predix Cloud Cache Clusters using Redis and Golang 10 Connect to Predix Cloud Cache Clusters using Redis and Java 12 Chapter 4: Backup and Restore 14 About Backing Up and Restoring Cached Data 15 Chapter 5: Migrating to New Subscription Plan 16 About New Subscription Plans 17 Migrate to a New Subscription Plan 17 Chapter 6: Security 18 About Predix Cloud Cache Security 19 Chapter 7: Reference 20 Performance Benchmarking 21 ii Predix Cloud Cache Chapter 8: Release Notes 22 Second Quarter of 2020 23 iii Copyright GE Digital © 2020 General Electric Company. GE, the GE Monogram, and Predix are either registered trademarks or trademarks of General Electric Company. All other trademarks are the property of their respective owners. This document may contain Confidential/Proprietary information of General Electric Company and/or its suppliers or vendors. Distribution or reproduction is prohibited without permission. THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO REPRESENTATION OR WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHER LIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLY DISCLAIMED. Access to and use of the software described in this document is conditioned on acceptance of the End User License Agreement and compliance with its terms. iv © 2020 General Electric Company Chapter 1 Overview Topics: • Overview of Predix Cloud Cache • Predix Cloud Cache Architecture © 2020 General Electric Company 1 Overview of Predix Cloud Cache Predix Cloud Cache is a fully managed in-memory data store and cache service. It improves the performance of web applications by retrieving information from managed in-memory caches, instead of relying entirely on slower disk-based databases. Predix Cloud Cache is backed by Amazon ElastiCache and helps you overcome the challenges, such as slow processing queries, scaling costs, simplified data access, and so on, faced while building distributed applications that require low latency and scalability. Predix Cloud Cache V2.0 supports the Redis (version 4.0 and higher) in-memory caching engine. Predix Cloud Cache Architecture The following architecture diagram provides a high-level information on how a user application interacts with an Amazon ElastiCache (Redis) instance using the Predix Cloud Cache service. The Predix Cloud Cache Broker facilitates the interaction between the user application and the Amazon ElastiCache service, and manages the lifecycle of the service instance. When the Predix Cloud Cache instance is created for the user, the user application interacts with the Amazon ElastiCache (Redis) instance through the host URL for the Predix Cloud Cache instance. 2 © 2020 General Electric Company Chapter 2 Configuring Predix Cloud Cache Service Topics: • Configure Predix Cloud Cache Service • Create Predix Cloud Cache Service Instance • Bind the Cloud Foundry Application to the Predix Cloud Cache Service Instance • Update Predix Cloud Cache Service Instance • Unbind the Predix Cloud Cache Service Instance from the Cloud Foundry Application • Delete Predix Cloud Cache Service Instance © 2020 General Electric Company 3 Configure Predix Cloud Cache Service About This Task You must create a service instance, and then bind the Cloud Foundry (CF) application to that instance to set up the Predix Cloud Cache service. Procedure 1. Create the Predix Cloud Cache service instance. 2. Bind the CF application to the Predix Cloud Cache service instance. Create Predix Cloud Cache Service Instance About This Task You can create the Predix Cloud Cache service instance with the default parameters, or with customized Redis engine version and cluster configuration parameters. Procedure 1. In the Cloud Foundry Command Line Interface, run the following command to access the list of Predix Cloud Cache plans that are available for subscription: cf m -s predix-cloud-cache-r2.0 Note: For more information on the Predix Cloud Cache plans, refer to the documentation on the new subscription plans. 2. Depending on whether you want to use the default or customized parameters, perform one of the following tasks: • Create the instance with the default parameters. • Create the instance with customized parameters. Create Service Instance with Default Parameters Procedure 1. Access the Cloud Foundry (CF) Command Line Interface. 2. Run the following command to create the Predix Cloud Cache service instance: cf create-service predix-cloud-cache-r2.0 <predix_cloud_cache_plan_name> <service_instance_name> Note: • The angle brackets (< >) in the command indicate placeholder text. You must replace the placeholder text with an appropriate value before running the command. • By default, the Predix Cloud Cache service supports Redis version 4.0.10. 4 © 2020 General Electric Company Example: The following command will create a service instance named MyDb based on the Predix Cloud Cache plan named Dedicated-2node-6gb: cf create-service predix-cloud-cache-r2.0 Dedicated-2node-6gb MyDb Next Steps Bind the CF application to the Predix Cloud Cache service instance. Create Service Instance with Customized Parameters About This Task You can create the Predix Cloud Cache service instance with customized Redis engine version and cluster configuration parameters. You can add the updated parameter values in a <custom-config>.json file, and then use this file to pass the customized values during the create service call. The content of the <custom-config>.json file must be in the following format: { "CreateReplicationGroup": { "EngineVersion": "<SampleEngineVersion>" }, "ParameterNameValues": [{ "ParameterName": "<SampleName>", "ParameterValue": "<SampleValue>" }] } Important: • In this task, angle brackets (< >) indicate placeholder text. If such placeholder text is part of a command, you must replace it with an appropriate value before running the command. • For more information on the parameters that are supported by your Redis engine, refer to the Amazon ElastiCache documentation. Procedure 1. Access the Cloud Foundry (CF) Command Line Interface. 2. Run one of the following commands to create the Predix Cloud Cache service instance: • cf create-service predix-cloud-cache-r2.0 <predix_cloud_cache_plan_name> <service_instance_name> -c <custom- config>.json • cf create-service predix-cloud-cache-r2.0 <predix_cloud_cache_plan_name> <service_instance_name> -c <content_of_<custom-config>.json> Example: The following command will create a service instance named MyDb based on the Predix Cloud Cache plan named Dedicated-2node-6gb, and the value of the parameter named activedefrag will be set to yes: cf create-service predix-cloud-cache-r2.0 Dedicated-2node-6gb MyDb - c ‘{ "CreateReplicationGroup": { "EngineVersion": "5.0.0" }, "ParameterNameValues": [{ "ParameterName": "activedefrag","ParameterValue": "yes"}]}' © 2020 General Electric Company 5 Note: • The Predix Cloud Cache service supports Redis version 4.0.10 and higher. • You can specify a maximum of 10 customized parameters in a create request. Next Steps Bind the CF application to the Predix Cloud Cache service instance. Bind the Cloud Foundry Application to the Predix Cloud Cache Service Instance Procedure 1. Access the Cloud Foundry (CF) Command Line Interface. 2. Run the following command to bind the CF application to the Predix Cloud Cache service instance: cf bind-service <application_name> <service_instance_name> Important: The angle brackets (< >) in the command indicate placeholder text. You must replace it with an appropriate value before running the command. Example: The following command will bind the CF application named MyApp to the service instance named MyDb: cf bind-service MyApp MyDb 3. Run the following command to access the list of all environment variables of the CF application: cf env <application_name> 4. In the list of environment variables, verify the parameter values defined for the service instance are correctly appearing for the VCAP_SERVICES variable. Example: "VCAP_SERVICES": { "predix-cloud-cache-r2.0": [ { "credentials": { "custom_parameters": { "ParameterNameValues": [ { "ParameterName": "active-defrag-cycle-max", "ParameterValue": "50" } ] }, "engineversion": "4.0.10", "host": "sample.cache.amazonaws.com", "password": "samplepassword", "port": 6379 }, 6 © 2020 General Electric Company Update Predix Cloud Cache Service Instance About This Task You can update the Predix Cloud Cache service instance by updating the parameter values of the instance. However, you cannot modify the values of the following parameters and attributes of the service instance: • Version of the Redis engine • Parameters that need a reboot of the cluster after modification • Parameters that cannot be modified in Amazon ElastiCache Redis. For more information on the supported parameters, refer to the Amazon ElastiCache documentation. You can add the updated