Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ibm-cloud/configuration-discovery
Infrastructure reverse engineering tool for IBM Cloud - Beta Release
https://github.com/ibm-cloud/configuration-discovery
terraform terraformer
Last synced: 15 days ago
JSON representation
Infrastructure reverse engineering tool for IBM Cloud - Beta Release
- Host: GitHub
- URL: https://github.com/ibm-cloud/configuration-discovery
- Owner: IBM-Cloud
- License: apache-2.0
- Created: 2021-09-06T05:46:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-02T08:54:34.000Z (over 2 years ago)
- Last Synced: 2024-10-22T05:21:03.248Z (17 days ago)
- Topics: terraform, terraformer
- Language: JavaScript
- Homepage:
- Size: 1.07 MB
- Stars: 3
- Watchers: 13
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# IBM Cloud Configuration Discovery
Use "Configuration Discovery" to import the existing Cloud resources (in your account) and its configuration settings - to auto-generate the terraform configuration file (.tf) and state file (.tfstate). It makes it easy for you to adopt the Infrastructure-as-Code practices; it can reverse engineer the current IBM Cloud environment (that was provisioned using UI or CLI).
Configuration Discovery tool is powered by [Terraformer](https://github.com/GoogleCloudPlatform/terraformer/). This Tool will augment the terraformer, with a number of capabilities that are native to IBM Cloud.
## Dependencies
- [Terraform](https://www.terraform.io/downloads.html) 0.12.31 or 0.13+
- [Terraformer](https://github.com/GoogleCloudPlatform/terraformer) 0.8.17+
- [IBM Cloud Provider](https://github.com/IBM-Cloud/terraform-provider-ibm/)
- [Go](https://golang.org/doc/install) 1.15+ (to build the discovery tool)
- [Mongodb](https://docs.mongodb.com/manual/installation/) v4.4.5+ (to run as a server)
## Installation
### Configuration Discovery tool
Run this command to install the Terraformer and Configuration Discovery tool:
```
curl -qL https://raw.githubusercontent.com/IBM-Cloud/configuration-discovery/main/install.sh | sh
```
You can download pre-built binaries for linux and macOS on the [releases page](https://github.com/IBM-Cloud/configuration-discovery/releases).
### IBM Cloud Provider Plugin
* Download the IBM Cloud provider plugin for Terraform from [release page](https://github.com/IBM-Cloud/terraform-provider-ibm/releases).
* Unzip the release archive to extract the plugin binary (`terraform-provider-ibm_vX.Y.Z`).
* Move the binary into the Terraform [plugins directory](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins) for the platform.
- Linux/Unix: `~/.terraform.d/plugins/linux_amd64/`
- Mac OS X: `~/.terraform.d/plugins/darwin_amd64/`
## Usage
```
$> discovery
NAME:
IBM Cloud Discovery CLI - Lets you create state file and TF Config from Resources in your cloud account. For the green field and brown field imports of config and statefile, and all terraformer related
USAGE:
discovery [global options] command [command options] [arguments...]
VERSION:
0.1.1
COMMANDS:
help, h Shows a list of commands or help for one command
discovery:
version discovery version
config, configure discovery config [--config_name CONFIG_NAME]
import discovery import --services SERVICES_TO_IMPORT [--tags TAGS] [--config_name CONFIG_NAME] [--compact]
GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
```
### Configuration Discovery Commands
Below commands help you to import your resources into terraform configuration. For more detailed description, run `discovery help`. For help on a command, run `discovery help `
| Command | Description |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| discovery version | IBM Cloud Discovery CLI version. Gives you other dependency information. Shows all supported importable resources|
| discovery config | Create a local configuration directory for exporting the terrraform configuration and state files |
| discovery import | Import TF config and state for resources in your ibm cloud account. Import all the resources for this service|
You are now ready to use the [Configuration Discovery tool](cmd/discovery/tutorial.md) tutorial.
## Capabilities
- [Green-field scenario - importing the existing infrastructure on a clean state](cmd/discovery/capabilities.md#green-field-import-scenario )
- [Upgrading the Terraform state file to the latest Terraform versions](cmd/discovery/capabilities.md#upgrading-the-terraform-state-file-to-the-latest-terraform-versions)
## Future Enhancements
- Brown-field scenario - importing the existing infrastructure and merge the generated Terraform files into the presence of already existing Terraform files.
- Rewrite Terraform resource into Terraform modules.
- Supports integration of the Configuration Discovery tool into the [VS Code extension for IBM Cloud Schematics](https://www.ibm.com/cloud/blog/announcements/introducing-the-visual-studio-code-extension-for-ibm-cloud-schematics)
## Steps to use the Configuration Discovery
### Files
* main.go
This file contains the web server and handlers.
* cmd/discovery
Code for the tool.
### Steps to use the project as an tool
* Build and install the tool to your GOPATH
make install-cli
* Export the required env vars
IC_API_KEY: Your ibm cloud api key. Imports resources in that account, for which user has access.
DISCOVERY_CONFIG_DIR: Directory, where to generate and import the terraform code. discovery uses only this directory for any read/write op.
* Example commands
discovery version
discovery config --config_name testfolder
discovery import --services ibm_is_vpc --config_name testfolder --compact --merge
### Steps to use as a server
* Start the server
cd /go/src/github.com
git clone [email protected]:IBM-Cloud/configuration-discovery.git
cd configuration-discovery/
go run main.go docs.go
http://localhost:8080
* Or
make run-mac
### How to run the Configuration Discovery as a docker container
* Run as docker container
make docker-build
make docker-run
First two need mongodb service running on localhost:27017. Third needs mongodb running as docker container. To run mongodb as docker container with 27017 exposed outside. This will work for all three methods above. Run this before any of the above steps
make docker-run-mongo
### How to run the configuration discovery as a container
cd /go/src/github.com
git clone [email protected]:IBM-Cloud/configuration-discovery.git
cd configuration-discovery/
docker build -t configuration-discovery .
docker images
export API_IMAGE=configuration-discovery:latest
docker-compose up --build -d
### Contributing to Configuration Discovery
Please have a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) file for some guidance before
submitting a pull request.
## Report a Issue / Feature request
- Is something broken? Have a issue/bug to report? use the [Bug report](https://github.com/IBM-Cloud/configuration-discovery/issues/new?assignees=&labels=&template=bug_report.md&title=) link. But before raising a issue, please check the [issues list](https://github.com/IBM-Cloud/configuration-discovery/issues) to see if the issue is already raised by someone
- Do you have a new feature or enhancement you would like to see? use the [Feature request](https://github.com/IBM-Cloud/configuration-discovery/issues/new?assignees=&labels=&template=feature_request.md&title=) link.
- Head to [config-discovery-users](https://ibm-cloud-schematics.slack.com/archives/C02GU9WNN4S) slack channel to engage with the team.
## License
The project is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
A copy is also available in the LICENSE file in this repository.