https://github.com/nmasse-itix/3scale-loader
A script that loads sample data in 3scale
https://github.com/nmasse-itix/3scale-loader
Last synced: about 2 months ago
JSON representation
A script that loads sample data in 3scale
- Host: GitHub
- URL: https://github.com/nmasse-itix/3scale-loader
- Owner: nmasse-itix
- License: mit
- Created: 2017-06-01T07:35:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-02T08:34:41.000Z (about 8 years ago)
- Last Synced: 2025-03-14T02:39:39.557Z (3 months ago)
- Language: JavaScript
- Size: 583 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 :
- `Hidden` is checked
- `Read Only` is 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 -admin.3scale.net --token --accounts 2 --applications 3 --users 1 --verbose
```
To cleanup the created objects :
```
3scale-loader cleanup --host -admin.3scale.net --token --verbose
```
To get some help :
```
3scale-loader --help
```