Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sachin1678/terraform-workspace-clone

Clone existing terraform workspace
https://github.com/sachin1678/terraform-workspace-clone

clone terraform workspace

Last synced: 28 days ago
JSON representation

Clone existing terraform workspace

Host: GitHub
URL: https://github.com/sachin1678/terraform-workspace-clone
Owner: Sachin1678
License: mit
Created: 2022-03-30T17:15:20.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-05-27T03:31:15.000Z (over 2 years ago)
Last Synced: 2024-10-10T07:41:00.776Z (28 days ago)
Topics: clone, terraform, workspace
Language: TypeScript
Homepage: https://www.npmjs.com/package/terraform-workspace-clone
Size: 699 KB
Stars: 8
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

terraform-workspace-clone

## NPM package to clone or duplicate extsting terraform workspace.

Downloads

# Getting started
### terraform-workspace-clone is a command-line module to clone terraform workspace.

### 🏠 [Homepage](https://github.com/Sachin1678/terraform-workspace-clone#readme)

## Install

```sh
npm install -g terraform-workspace-clone
```

## Usage
`terraform-workspace-clone` needs few details before cloning the workspace. Input can be provided using cli prompts or can pass pre-filled json file as command-line argument.
### Cli prompts:
Run below command in cli.
```
terraform-workspace-clone
```

Can also use `tf-ws-clone` , It is a shorthand command.

Example:
```
✔ TF domain name? https://app.terraform.io // Terraform domain, can be cloud or enterprise
✔ Source workspace ID? ws-9xZ3c3iabcdefgh // Workspace id which you need to clone
✔ New workspace name? 00-test-1 // New workspace name
✔ Destination TF organization name? abc_org // TF org name in which new workspace will be created.
✔ (Optional) OAuth Token id from destinaton organization? // Required if want to clone VCS config. Refer 2nd screenshot.
✔ User api token **************** // User api token. Screenshot 1. For more details go to `API Token` section of https://www.terraform.io/cloud-docs/users-teams-organizations/users.
✔ Do you want to clone with values? no / yes // Yes, if want to clone variables with values.
```

**NOTE:** User should have permission to access source and destination org.
1. To generate user api token, go to **User Settings -> Tokens -> click on "Create an API token" button -> Create API token -> Copy token -> Done**.
![User API token](https://raw.githubusercontent.com/Sachin1678/terraform-workspace-clone/main/screenshots/user_api_token.png)

2. To fetch VCS OAuth token ID, Select TF destination organization and go to **Settings -> Providers -> Copy OAuth client id**. Destination organization should be able to access VCS repo configured in source workspace. If VCS provider not configured then click on **Settings -> Providers -> Add VCS provider**.
![VCS token ID](https://raw.githubusercontent.com/Sachin1678/terraform-workspace-clone/main/screenshots/vcs_oauth_token.png)

### Config file:
Input can be passed using pre-filled json file. JSON file should have below info:

```
{
"baseUrl": "https://app.terraform.io",
"sourceWorkspaceId": "ws-9xZ3c3iabcdefgh",
"newWorkspaceName": "00-test-1",
"destinationOrgName": "abc_org",
"destinationOrgVcsOauthTokenId": "",
"userApiToken": "Zxcvbnm..............sjhsmD",
"isCloneValue": true or false
}
```
and then pass this file as a input.

```sh
tf-ws-clone --config=/.json
```

This template can be generated using cli command. It will create a config template file with all the required keys **`tf_ws_clone_config.json`** at same path from where `tf-ws-clone` command is executed.

```sh
tf-ws-clone initconfig
```

Example:
```
tf-ws-clone --config=./tf_ws_clone_config.json
```

### Running on-demand using npx:
Using `npx` you can run the script on-demand:
```
npx terraform-workspace-clone
```

```
npx terraform-workspace-clone --config=./tf_ws_clone_config.json
```

## Run tests

```sh
npm run test
```

## New planned features
* Clone across multiple domains.
* Allow config file path also for the required details.
## Author

👤 **Sachin **

* Github: [@Sachin1678](https://github.com/Sachin1678)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Sachin1678/terraform-workspace-clone/issues). You can also take a look at the [contributing guide](https://github.com/Sachin1678/terraform-workspace-clone/blob/master/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License