|
| 1 | +<!-- |
| 2 | +/* |
| 3 | + * Copyright IBM Corp. 2016 |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | +--> |
| 18 | +# Globalization Pipeline BETA Migration Guide |
| 19 | + |
| 20 | +## Overview |
| 21 | + |
| 22 | +Globalziation Pipeline BETA service will be retired in September 2016. |
| 23 | +If you want to keep the translation stored in an instance of Globalization |
| 24 | +Pipeline BETA service, you can migrate the data to a new instance of |
| 25 | +Globalization Pipeline service. |
| 26 | + |
| 27 | +## Step 1 - Download Globalization Pipeline CLI tool |
| 28 | + |
| 29 | +This migration instruction utilizes [Globlization Pipeline |
| 30 | +CLI tool](https://github.com/IBM-Bluemix/gp-java-tools). The command |
| 31 | +used for migrating data is available gp-cli-1.1.0. To run the |
| 32 | +tool, you need Java SE Runtime Environment 7 or later version. |
| 33 | + |
| 34 | +## Step 2 - Save the BETA instance's credentials |
| 35 | + |
| 36 | +Logon to Bluemix console and browse the service credentials used by |
| 37 | +the BETA service instance. For more details, see [Credentials](README.md#4-credentials) |
| 38 | +in Quick Start Guide. |
| 39 | + |
| 40 | +Once you get the credential information, create a new json file |
| 41 | +and store the credentials as below. |
| 42 | +``` |
| 43 | +{ |
| 44 | + "url":"https://gp-beta-rest.ng.bluemix.net/translate/rest", |
| 45 | + "userId":"50b84f636581b91ca0f96df896fc813d", |
| 46 | + "password":"iN6Pu2ywoaVEB7O84kvnEND/t6MTeyTy", |
| 47 | + "instanceId":"4e10de1652319ab6ba69f197d3c3ac76" |
| 48 | +} |
| 49 | +``` |
| 50 | +Note: Credentials above are example, and actual property values |
| 51 | +are different. |
| 52 | + |
| 53 | +In this instruction, we use *betacreds.json* as the file name. |
| 54 | + |
| 55 | +## Step 3 - Creating a new Globalization Pipeline service |
| 56 | + |
| 57 | +You need a new Globalization Pipeline service instance to host translation |
| 58 | +bundles. To create a new service instance, please follow the steps |
| 59 | +explained in [Quick Start Guide](README.md#quick-start-guide). |
| 60 | + |
| 61 | +If the BETA instance was bound to your Bluemix Apps, you should also |
| 62 | +bind the new instance. |
| 63 | + |
| 64 | +After the new instance is created, browse the service credentials |
| 65 | +as you did in the previous step for beta. You need to save the value |
| 66 | +of *url*, *userId*, *password* and *instanceId*. (Note: The command used |
| 67 | +for transferring data to a new instance does not take target service |
| 68 | +instance's credentials in JSON file. So you don't need to create a |
| 69 | +JSON file for the new service instance.) |
| 70 | + |
| 71 | +## Step 4 - Run copy-all-bundles command |
| 72 | + |
| 73 | +Run copy-all-bundles command as below. |
| 74 | +``` |
| 75 | +java -jar cp-cli-1.1.0.jar copy-all-bundles --dest-url https://gp-rest.ng.bluemix.net/translate/rest --dest-instance-id 9146abf71bb94513504a0eaf76d57804 --dest-user-id 52858e19ae57ba6f2d2ea7e38e9ab457 --dest-password o75YXQCK2obQLOvedkSslBTAyeUq7/+t -j betacreds.json |
| 76 | +``` |
| 77 | +Above is an example. Parameter values should be replaced with |
| 78 | +actual credentials you saved in Step 2 and 3. |
| 79 | + |
| 80 | +* --dest-url - *url* in the instance's credentials (Step 3) |
| 81 | +* --dest-instance-id - *instanceId* in the instance's credentials (Step 3) |
| 82 | +* --dest-user-id - *userId* in the instance's credentials (Step 3) |
| 83 | +* --dest-password - *password* in the instance's credentials (Step 3) |
| 84 | +* --j - BETA instance's credentials stored in a JSON file (Step 2) |
| 85 | + |
| 86 | +Below is an example of command output. |
| 87 | +``` |
| 88 | +.. copying bundle: MyMessages1 |
| 89 | +.. copying bundle: MyMessages2 |
| 90 | +.. copying bundle: MyMessages3 |
| 91 | +All bundles were successfully copied to the specified service instance. |
| 92 | +``` |
| 93 | + |
| 94 | +## Step 5 - Update credentials in your application code (optional) |
| 95 | + |
| 96 | +If your application dynamically access the BETA intance using one of |
| 97 | +Globalization Pipleline SDK previously, and service credentials are |
| 98 | +manually set in your application, replace the one for BETA with the |
| 99 | +new instance's credentials. |
| 100 | + |
| 101 | +Also, you may want to update the client SDK to the latest version, |
| 102 | +although previous version client SDK released for BETA service |
| 103 | +should continue to work. |
0 commit comments