| Name | rl-deploy JSON |
| Version |
2.2.9.0
JSON |
| download |
| home_page | None |
| Summary | Deployment tool for ReversingLabs rl-secure project. |
| upload_time | 2025-02-13 09:27:43 |
| maintainer | None |
| docs_url | None |
| author | ReversingLabs |
| requires_python | >=2.7 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# rl-deploy by ReversingLabs
rl-deploy is a tool for fast and flexible installation of rl-secure (Spectra Assure CLI) in ephemeral and cloud infrastructure, CI/CD environments, and containers.
Spectra Assure is a software supply chain security platform created by ReversingLabs to help organizations develop and release software with confidence. To support automated security scanning of software releases, ReversingLabs developed the Spectra Assure CLI tool called rl-secure.
This guide explains how to use rl-deploy to install rl-secure. For more details, visit the [official Spectra Assure documentation](https://docs.secure.software/cli).
## Installation
rl-deploy requires Python 3.x.
It can be installed on the following systems and architectures:
- Windows 10 and later, 64-bit
- Linux x86 (all major distributions), 64-bit
To install the latest version of rl-deploy from PyPI, run:
```
pip install rl-deploy
```
To confirm rl-deploy is successfully installed, run:
```
rl-deploy --version
```
## How to use rl-deploy
After installing rl-deploy to your system, use it to install the latest version of the rl-secure CLI tool.
1. Prepare your license and site key
Send an email to support@reversinglabs.com with the subject "rl-secure license request". In the email, ask for a site key that you will use to deploy rl-secure.
ReversingLabs Support will send you the license file and the site key. The site key is a string you can use to associate any rl-secure installation with your license. This allows you to install rl-secure on multiple ephemeral systems without having to request a separate license for each machine.
2. Install rl-secure
**Important note:** rl-secure implements an auto-update mechanism to keep the product up to date on every use. The user executing rl-secure commands must have write access to the installation location to facilitate the auto-update mechanism.
To install rl-secure on your system, provide the installation location, license, and the site key to the rl-deploy tool. You can either provide the path to the license file, or convert the license file contents into a Base64-encoded string.
**Install with encoded license key**
```
rl-deploy install --location /path/to/destination/ --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key
```
**Install with license file path**
```
rl-deploy install --location /path/to/destination/ --license-file /path/to/license.key --site-key=your-site-key
```
3. Confirm rl-secure installation
Access the location where you installed rl-secure and run the following command to confirm it's successfully installed.
```
rl-secure --version
```
## Configuration
The rl-deploy tool supports proxy configuration in case it's required to download and install rl-secure.
You can specify the proxy configuration parameters directly when installing rl-secure:
```
rl-deploy install --location /path/to/destination/ --license-file /path/to/license.key --site-key=your-site-key --proxy-server 127.0.0.1 --proxy-port 8080
```
Proxy settings used during installation are automatically saved to the rl-secure configuration file, so rl-secure can continue using them when it needs to connect to ReversingLabs servers.
Note the rl-deploy proxy configuration does not support system-provided certificates, so it will not work if you have a custom certificate.
## Cached installation
By default, `rl-deploy install` downloads the `rl-secure` package from ReversingLabs servers to perform a fresh install. When this mechanism is used in ephemeral configurations, repeated `install` invocations result in a lot of time spent on the `rl-secure` package download process. To skip the download process, `rl-deploy` can perform the installation of `rl-secure` from a local cached installation file.
To utilize this mechanism in your setup, you need to perform two steps:
1. Create a cached installation file of the latest `rl-secure` version
2. Use that cached file during the installation
### Generate a cached installation file
To create a cached installation file, use the `rl-deploy cache` command. This command will connect to the official update servers using your provided license information, and download the cached package to a location of your choice.
Note that your license information is used only for access control. It is not embedded inside the cached installation package.
```
rl-deploy cache --location /path/to/cache.file --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key
```
### Use the cached file to perform installation
To install `rl-secure` from the cached installation file, you only need to specify the `from-cache` command line parameter in your `rl-deploy install` command.
```
rl-deploy install --from-cache /path/to/cache.file --location /path/to/destination/ --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key
```
Note that `rl-secure` performs an automatic update on each scan. This means you will have to regenerate the cached installation file when a new version of `rl-secure` is released. Otherwise you will lose all benefits of this functionality.
## Support
To share your feedback or report any issues with rl-deploy, send an email to support@reversinglabs.com
Raw data
{
"_id": null,
"home_page": null,
"name": "rl-deploy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": null,
"author": "ReversingLabs",
"author_email": "secure.software@reversinglabs.com",
"download_url": null,
"platform": null,
"description": "# rl-deploy by ReversingLabs\n\nrl-deploy is a tool for fast and flexible installation of rl-secure (Spectra Assure CLI) in ephemeral and cloud infrastructure, CI/CD environments, and containers.\n\nSpectra Assure is a software supply chain security platform created by ReversingLabs to help organizations develop and release software with confidence. To support automated security scanning of software releases, ReversingLabs developed the Spectra Assure CLI tool called rl-secure. \n\nThis guide explains how to use rl-deploy to install rl-secure. For more details, visit the [official Spectra Assure documentation](https://docs.secure.software/cli).\n\n\n## Installation\n\nrl-deploy requires Python 3.x. \n\nIt can be installed on the following systems and architectures:\n\n- Windows 10 and later, 64-bit\n- Linux x86 (all major distributions), 64-bit\n\nTo install the latest version of rl-deploy from PyPI, run:\n\n\n```\npip install rl-deploy\n```\n\n\nTo confirm rl-deploy is successfully installed, run:\n\n\n```\nrl-deploy --version\n```\n\n\n## How to use rl-deploy\n\nAfter installing rl-deploy to your system, use it to install the latest version of the rl-secure CLI tool.\n\n1. Prepare your license and site key\n\nSend an email to support@reversinglabs.com with the subject \"rl-secure license request\". In the email, ask for a site key that you will use to deploy rl-secure.\n\nReversingLabs Support will send you the license file and the site key. The site key is a string you can use to associate any rl-secure installation with your license. This allows you to install rl-secure on multiple ephemeral systems without having to request a separate license for each machine.\n\n2. Install rl-secure\n\n**Important note:** rl-secure implements an auto-update mechanism to keep the product up to date on every use. The user executing rl-secure commands must have write access to the installation location to facilitate the auto-update mechanism.\n\nTo install rl-secure on your system, provide the installation location, license, and the site key to the rl-deploy tool. You can either provide the path to the license file, or convert the license file contents into a Base64-encoded string.\n\n**Install with encoded license key**\n\n```\nrl-deploy install --location /path/to/destination/ --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key\n```\n\n**Install with license file path**\n\n```\nrl-deploy install --location /path/to/destination/ --license-file /path/to/license.key --site-key=your-site-key\n```\n\n3. Confirm rl-secure installation\n\nAccess the location where you installed rl-secure and run the following command to confirm it's successfully installed.\n\n```\nrl-secure --version\n```\n\n\n## Configuration\n\nThe rl-deploy tool supports proxy configuration in case it's required to download and install rl-secure.\n\nYou can specify the proxy configuration parameters directly when installing rl-secure:\n\n```\nrl-deploy install --location /path/to/destination/ --license-file /path/to/license.key --site-key=your-site-key --proxy-server 127.0.0.1 --proxy-port 8080\n```\n\nProxy settings used during installation are automatically saved to the rl-secure configuration file, so rl-secure can continue using them when it needs to connect to ReversingLabs servers.\n\nNote the rl-deploy proxy configuration does not support system-provided certificates, so it will not work if you have a custom certificate. \n\n\n## Cached installation\n\nBy default, `rl-deploy install` downloads the `rl-secure` package from ReversingLabs servers to perform a fresh install. When this mechanism is used in ephemeral configurations, repeated `install` invocations result in a lot of time spent on the `rl-secure` package download process. To skip the download process, `rl-deploy` can perform the installation of `rl-secure` from a local cached installation file.\n\nTo utilize this mechanism in your setup, you need to perform two steps:\n\n 1. Create a cached installation file of the latest `rl-secure` version\n 2. Use that cached file during the installation\n\n### Generate a cached installation file\n\nTo create a cached installation file, use the `rl-deploy cache` command. This command will connect to the official update servers using your provided license information, and download the cached package to a location of your choice.\n\nNote that your license information is used only for access control. It is not embedded inside the cached installation package.\n\n```\nrl-deploy cache --location /path/to/cache.file --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key\n```\n\n### Use the cached file to perform installation\n\nTo install `rl-secure` from the cached installation file, you only need to specify the `from-cache` command line parameter in your `rl-deploy install` command.\n\n```\nrl-deploy install --from-cache /path/to/cache.file --location /path/to/destination/ --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key\n```\n\nNote that `rl-secure` performs an automatic update on each scan. This means you will have to regenerate the cached installation file when a new version of `rl-secure` is released. Otherwise you will lose all benefits of this functionality.\n\n## Support\n\nTo share your feedback or report any issues with rl-deploy, send an email to support@reversinglabs.com\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Deployment tool for ReversingLabs rl-secure project.",
"version": "2.2.9.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e2d18f037a796aef4f138eebfd0eb2d17067af65b66ea9e228dde2ccd1b0874",
"md5": "299eb11ef79f61f0ff98d84ac70c7ad0",
"sha256": "6d45c689f4a4e6c82d84a6fb1435efdb65c27ed1e4317979d2754f45fe5adc5b"
},
"downloads": -1,
"filename": "rl_deploy-2.2.9.0-py2.py3-none-manylinux1_x86_64.whl",
"has_sig": false,
"md5_digest": "299eb11ef79f61f0ff98d84ac70c7ad0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7",
"size": 4282503,
"upload_time": "2025-02-13T09:27:43",
"upload_time_iso_8601": "2025-02-13T09:27:43.454294Z",
"url": "https://files.pythonhosted.org/packages/9e/2d/18f037a796aef4f138eebfd0eb2d17067af65b66ea9e228dde2ccd1b0874/rl_deploy-2.2.9.0-py2.py3-none-manylinux1_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29c08bc98cd147e8101f65ec421661e5da6a6c96f7a9cdf492ceed17dd65f624",
"md5": "5927a1468713ae82ee19550f82bb5f76",
"sha256": "727e9d5b4d08813eefbe1a5f15a26b5c635850a2fe360379be2ad010d51079e8"
},
"downloads": -1,
"filename": "rl_deploy-2.2.9.0-py2.py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "5927a1468713ae82ee19550f82bb5f76",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7",
"size": 2633825,
"upload_time": "2025-02-13T09:27:46",
"upload_time_iso_8601": "2025-02-13T09:27:46.363740Z",
"url": "https://files.pythonhosted.org/packages/29/c0/8bc98cd147e8101f65ec421661e5da6a6c96f7a9cdf492ceed17dd65f624/rl_deploy-2.2.9.0-py2.py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-13 09:27:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rl-deploy"
}
