@ibm-cloud/cd-tools 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,2 +1,67 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
1
|
+
# Continuous Delivery tools
|
|
2
|
+
|
|
3
|
+
Provides tools to work with IBM Cloud Continuous Delivery resources, including **Toolchains**, **Delivery Pipelines**, and **Git Repos and Issue Tracking** projects.
|
|
4
|
+
|
|
5
|
+
#### Supported resources
|
|
6
|
+
| Resource | Supported |
|
|
7
|
+
| :- | :- |
|
|
8
|
+
| Toolchains | Yes <sup>1</sup> |
|
|
9
|
+
| Git Repos and Issue Tracking projects | Yes <sup>2</sup> |
|
|
10
|
+
| Delivery Pipelines (Tekton) | Yes <sup>1</sup> <sup>3</sup> |
|
|
11
|
+
| Delivery Pipelines (Classic) | No |
|
|
12
|
+
| DevOps Insights | No |
|
|
13
|
+
| Other Tool Integrations | Yes |
|
|
14
|
+
|
|
15
|
+
#### Limitations
|
|
16
|
+
1. Secrets stored directly in Toolchains or Delivery Pipelines (environment properties or trigger properties) will not be copied. A `check-secrets` tool is provided to export secrets into a Secrets Manager instance, replacing the stored secrets with secret references. Secret references are supported in the migration.
|
|
17
|
+
2. Personal Access Tokens will not be copied.
|
|
18
|
+
3. Pipeline run history, logs, and assets will not be copied to the new region. You can keep the original pipelines for some time to retain history.
|
|
19
|
+
4. Classic pipelines are not supported.
|
|
20
|
+
5. DevOps Insights is not supported.
|
|
21
|
+
|
|
22
|
+
## Prerequisites
|
|
23
|
+
- Node.js v20 (or later)
|
|
24
|
+
- Terraform v1.13.3 (or later)
|
|
25
|
+
- Terraformer v0.8.30 (or later)
|
|
26
|
+
- An **IBM Cloud API key** with the following IAM access permissions:
|
|
27
|
+
- **Viewer** for the source Toolchain(s) being copied
|
|
28
|
+
- **Editor** for create new Toolchains in the target region
|
|
29
|
+
- **Administrator** for other IBM Cloud service instances that have a tool integration with IAM service-to-service authorizations, such as Secrets Manager, Event Notifications, etc.
|
|
30
|
+
- For Git Repos and Issue Tracking projects, Personal Access Tokens (PAT) for the source and destination regions are required, with the `api` scope.
|
|
31
|
+
|
|
32
|
+
## Install
|
|
33
|
+
### Install Node.js, Terraform, Terraformer
|
|
34
|
+
|
|
35
|
+
#### MacOS
|
|
36
|
+
```sh
|
|
37
|
+
brew install node
|
|
38
|
+
brew tap hashicorp/tap
|
|
39
|
+
brew install hashicorp/tap/terraform
|
|
40
|
+
brew install terraformer
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### Other platfoms
|
|
44
|
+
- Node.js [install instructions](https://nodejs.org/en/download)
|
|
45
|
+
- Terraform [install instructions](https://developer.hashicorp.com/terraform/install)
|
|
46
|
+
- Terraformer [install instructions](https://github.com/GoogleCloudPlatform/terraformer?tab=readme-ov-file#installation)
|
|
47
|
+
|
|
48
|
+
## Usage
|
|
49
|
+
|
|
50
|
+
The tools are provided as an [npx](https://docs.npmjs.com/cli/commands/npx) command which automatically downloads and runs the module. To see the available commands, run `npx @ibm-cloud/cd-tools` on your command line.
|
|
51
|
+
|
|
52
|
+
```shell-session
|
|
53
|
+
$ npx @ibm-cloud/cd-tools
|
|
54
|
+
Usage: npx @ibm-cloud/cd-tools [options] [command]
|
|
55
|
+
|
|
56
|
+
Tools for migrating Toolchains, Delivery Pipelines, and Git Repos and Issue Tracking projects.
|
|
57
|
+
|
|
58
|
+
Options:
|
|
59
|
+
-V, --version output the version number
|
|
60
|
+
-h, --help display help for command
|
|
61
|
+
|
|
62
|
+
Commands:
|
|
63
|
+
copy-project-group [options] Bulk migrate GitLab group projects
|
|
64
|
+
check-secrets [options] Checks if you have any stored secrets in your toolchain or pipelines
|
|
65
|
+
copy-toolchain [options] Copies a toolchain, including tool integrations and Tekton pipelines, to another region or resource group.
|
|
66
|
+
help [command] display help for command
|
|
67
|
+
```
|