Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.96 KB

README.md

File metadata and controls

62 lines (40 loc) · 2.96 KB
Raw

Codespell E2E Go Report Card Commit Activity

IDP Builder

Internal development platform binary launcher.

About

Spin up a complete internal developer platform using industry standard technologies like Kubernetes, Argo, and backstage with only Docker required as a dependency.

This can be useful in several ways:

  • Create a single binary which can demonstrate an IDP reference implementation.
  • Use within CI to perform integration testing.
  • Use as a local development environment for platform engineers.

Getting Started

The easiest way to get started is to grab the idpbuilder binary for your platform and run it. You can visit our nightly releases page to download the version for your system, or run the following commands:

arch=$(if [[ "$(uname -m)" == "x86_64" ]]; then echo "amd64"; else uname -m; fi)
os=$(uname -s | tr '[:upper:]' '[:lower:]')


idpbuilder_latest_tag=$(curl --silent "https://api.github.com/repos/cnoe-io/idpbuilder/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
curl -LO  https://github.com/cnoe-io/idpbuilder/releases/download/$idpbuilder_latest_tag/idpbuilder-$os-$arch.tar.gz
tar xvzf idpbuilder-$os-$arch.tar.gz

You can then run idpbuilder with the create argument to spin up your CNOE IDP:

./idpbuilder create

For more detailed information, checkout our documentation website on getting started with idpbuilder.

Community

  • If you have questions or concerns about this tool, please feel free to reach out to us on the CNCF Slack Channel.
  • You can also join our community meetings to meet the team and ask any questions. Checkout this calendar for more information.

Contribution

Checkout the contribution doc for contribution guidelines and more information on how to set up your local environment.