3scale-loader 中文文档教程
A script that loads sample data in your 3scale account
Why ?
有时做 3scale 的演示，你想用样本数据填充你的帐户。
Overview
这个脚本做了两件事：
- create some sample data (accounts, applications, users) in your 3scale account.
- cleanup your platform (ie. delete the previously created accounts, applications, users).
Preparation
Create an Access Token (MANDATORY)
转到您的 3scale 管理控制台并单击右上角的齿轮图标 并深入到 Personal Settings > 令牌。
创建访问令牌并将生成的令牌保存在安全的地方。 确保选中“帐户管理 API”范围并设置权限 设置为“读/写”。
Create an extra field (RECOMMENDED)
如果您创建一个名为“x-created-by”的额外字段，脚本将使用它来标记 帐户、应用程序和用户，以便稍后可以进行清理。
如果未创建此额外字段，则不会进行清理。
要创建此字段，请转到您的 3scale 管理控制台并向下钻取 设置 > Fields Definition 并创建三个字段：
- a user field named
x-created-by - an account field named
x-created-by - an application field named
x-created-by
确保名称为 x-created-by（该名称目前是硬编码的）并且：
Hiddenis checkedRead Onlyis checked
Installation
安装这个脚本最简单的方法是通过 NPM：
npm install -g 3scale-loader
How to use it
创建 2 个示例帐户，每个帐户中有 3 个应用程序，每个帐户中有 1 个额外的用户：
3scale-loader create --host <tenant>-admin.3scale.net --token <your-access-token> --accounts 2 --applications 3 --users 1 --verbose
清理创建的对象：
3scale-loader cleanup --host <tenant>-admin.3scale.net --token <your-access-token> --verbose
获得一些帮助：
3scale-loader --help
A script that loads sample data in your 3scale account
Why ?
Sometime to do a demo of 3scale, you would like to populate your account with sample data.
Overview
This scripts does two things :
- create some sample data (accounts, applications, users) in your 3scale account.
- cleanup your platform (ie. delete the previously created accounts, applications, users).
Preparation
Create an Access Token (MANDATORY)
Go to your 3scale admin console and click on the gear icon on the top right corner and drill down to Personal Settings > Tokens.
Create an access token and keep the generated token in a safe place. Make sure the "Account Management API" scope is checked and permissions is set to "Read/write".
Create an extra field (RECOMMENDED)
If you create an extra field named "x-created-by", the script will use it to mark the accounts, applications and users so that it can do the cleanup later.
If this extra field is not created, the cleanup will not be done.
To create this field, go to your 3scale admin console and drill down to Settings > Fields Definition and create three fields :
- a user field named
x-created-by - an account field named
x-created-by - an application field named
x-created-by
Make sure the name is x-created-by (the name is currently hardcoded) and :
Hiddenis checkedRead Onlyis checked
Installation
The easiest way to install this script is through NPM :
npm install -g 3scale-loader
How to use it
To create 2 sample accounts, 3 applications in each account and 1 additional user in each account :
3scale-loader create --host <tenant>-admin.3scale.net --token <your-access-token> --accounts 2 --applications 3 --users 1 --verbose
To cleanup the created objects :
3scale-loader cleanup --host <tenant>-admin.3scale.net --token <your-access-token> --verbose
To get some help :
3scale-loader --help
