https://github.com/cloudblue/apsconnect-cli
Warning: EOL for January 2021. CloudBlue Connect CLI tool to automate APS Package management in the CloudBlue Commerce instance (hub).
https://github.com/cloudblue/apsconnect-cli
aps apsstandard connector kubernetes utility
Last synced: 2 months ago
JSON representation
Warning: EOL for January 2021. CloudBlue Connect CLI tool to automate APS Package management in the CloudBlue Commerce instance (hub).
- Host: GitHub
- URL: https://github.com/cloudblue/apsconnect-cli
- Owner: cloudblue
- License: apache-2.0
- Created: 2017-06-09T15:43:06.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T21:45:02.000Z (about 3 years ago)
- Last Synced: 2025-11-27T12:38:17.934Z (7 months ago)
- Topics: aps, apsstandard, connector, kubernetes, utility
- Language: Python
- Homepage: https://connect.cloudblue.com/documentation/extensions/cloudblue-commerce/
- Size: 296 KB
- Stars: 14
- Watchers: 9
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Warning: End of life is scheduled for January 2021
Functionality of this tool has been superseded by the [CloudBlue Commerce Extension](https://connect.cloudblue.com/documentation/extensions/cloudblue-commerce/) and the end-of-life for this tool is scheduled for January 2021.
# apsconnect-cli
_CloudBlue Connect command line tool to automate product lifecycle management for the CloudBlue Commerce._
 [](https://travis-ci.org/cloudblue/apsconnect-cli) [](https://pypi.python.org/pypi/apsconnectcli)
## How to install or update
APSConnect CLI tool is compatible with all recent Python releases of 2.7, 3.4, 3.5 and 3.6 versions.
Typically, all you need is just PyPI client, like [pip](https://pypi.python.org/pypi/pip):
```
pip install -U apsconnectcli
```
## Usage
#### 1 Connect to the CloudBlue Commerce instance (Hub)
The host where this command is executed needs to have network connectivity to the CloudBlue Commerce instance.
```
apsconnect init-hub
--hub-host HUB_HOST
[--user USER]
[--pwd PWD]
[--use-tls USE_TLS]
[--port PORT]
[--aps-host APS_HOST]
[--aps-port APS_PORT]
[--use-tls-aps USE_TLS_APS]
```
```
⇒ apsconnect init-hub oa-hub-hostname
APSConnect-cli v.1.7.11
Connectivity with hub RPC API [ok]
Hub version oa-7.1-3256
Connectivity with hub APS API [ok]
Config saved [/Users/user/.aps_config]
```
#### 2 Install APS Package into the CloudBlue Commerce Automation Hub
```
apsconnect install-frontend
--source SOURCE
--oauth-key OAUTH_KEY
--oauth-secret OAUTH_SECRET
--backend-url BACKEND_URL
[--settings SETTINGS]
[--network NETWORK]
[--hub-id HUB_ID]
[--instance-only INSTANCE_ONLY]
[--experimental EXPERIMENTAL]
```
```
⇒ apsconnect install-frontend package.aps.zip 687fd3e99eb 61aaf74a5c622d1fa34 --backend-url http://127.0.0.1/
APSConnect-cli v19
Importing connector http://connect.cloudblue.com/product/example
Connector http://connect.cloudblue.com/product/example imported with id=206 [ok]
Resource types creation [ok]
Service template "Product A" created with id=16 [ok]
Limits for Service template "16" are applied [ok]
```
The `--settings` parameter is normally not required, it should point to a file containing data in JSON format that will be mixed in to application instance create API request.
Can be used to provide custom application instance global settings.
Use `--instance-only` flag if you wish to skip resource types and service templates creation.
**WARNING** Due to limitations of CloudBlue Commerce API importing large (more than a few megabytes) packages from local source might fail.
Use HTTP link as source for such packages.
## Misc
#### Check utility version
```
⇒ apsconnect version
apsconnect-cli v.1.7.11 built with love.
```
#### Generate Oauth credentials with helper command
```
apsconnect generate-oauth [--namespace]
```
```
⇒ apsconnect generate-oauth test
OAuh key: test-c77e25b1d6974a87b2ff7f58092d6007
Secret: 14089074ca9a4abd80ba45a19baae693
```
_Note that `--source` gets http(s):// or filepath argument._
#### Enable APS Development mode
Allows using non-TLS connector-backend URL and [other features for debug](http://doc.apsstandard.org/2.2/process/test/tools/mn/#development-mode).
```
⇒ apsconnect aps-devel-mode
APS Development mode ENABLED
```
Disable mode with `--disable`.
```
⇒ apsconnect aps-devel-mode --disable
APS Development mode DISABLED.
```
#### Get Hub token
```
⇒ apsconnect hub-token
ab8719ff-d818-4b6f-8023-0229f768e086
```