Skip to content

Commit

Permalink
docs: fix broken links in the README (#1561)
Browse files Browse the repository at this point in the history
  • Loading branch information
KashifSaadat authored Nov 20, 2024
1 parent 8b38a5a commit edd0dfa
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
[![GPL license](https://img.shields.io/badge/License-GPL-blue.svg)](http://perso.crans.org/besson/LICENSE.html)
[![GitHub go.mod Go version of a Go module](https://img.shields.io/github/go-mod/go-version/gomods/athens.svg)](https://github.com/gomods/athens)
[![GoReportCard example](https://goreportcard.com/badge/github.com/appvia/terranetes-controller)](https://goreportcard.com/report/github.com/appvia/terranetes-controller)
[![CodeQL](https://github.com/appvia/terranetes-controller/actions/workflows/codeql.yml/badge.svg)](https://github.com/appvia/terranetes-controller/actions/workflows/codeql.yml)
![Terranetes Controller](docs/images/logo-blue.png#gh-light-mode-only)![Terranetes Controller](docs/images/logo-white.png#gh-dark-mode-only)

<!-- markdownlint-disable -->

<p align="right"> <a href="https://terranetes.appvia.io"><img src="https://img.shields.io/static/v1?label=APPVIA&message=Docs&color=191970&style=for-the-badge" alt="Terranetes Docs"/></a> <a href="https://github.com/appvia/terranetes-controller/releases/latest"><img src="https://img.shields.io/github/v/release/appvia/terranetes-controller.svg?filter=v*&style=for-the-badge&color=006400" alt="Latest Release"/></a> <a href="https://kubernetes.slack.com/channels/terranetes"><img src="https://img.shields.io/badge/Slack-Join%20Community-purple?style=for-the-badge&logo=slack" alt="Slack Community"/></a> <a href="https://github.com/appvia/terranetes-controller/graphs/contributors"><img src="https://img.shields.io/github/contributors/appvia/terranetes-controller.svg?style=for-the-badge&color=FF8C00" alt="Contributors"/></a> <a href="https://github.com/appvia/terranetes-controller/stargazers"><img src="https://img.shields.io/github/stars/appvia/terranetes-controller.svg?style=for-the-badge&color=FFC501" alt="Stargazers"/></a> </p>

<!-- markdownlint-restore -->

# **TERRANETES CONTROLLER**

The Terranetes Controller manages the life cycles of a terraform resource, allowing developers to self-serve dependencies in a controlled manner.
The Terranetes Controller manages the lifecycle of an OpenTofu or Terraform resource, allowing developers to self-serve dependencies in a controlled manner.

There's a number of open source controllers you could use that will run Terraform in Kubernetes. All of them deliver the developer outcome, however, none address the "consequences" of delivering that outcome in the first place; the risks, costs, security implications, the general lack of checks and balances. What sets the Terranetes controller apart is its opinion we first enable the platform team to deliver the outcome in a safe environment before it can be self-served by developers. Providing platform engineers with all the knobs, dials and levers to control and mitigate those risks is the key differentiator for Terranetes controller.
There's a number of open source controllers you could use that will run OpenTofu or Terraform in Kubernetes. All of them deliver the developer outcome, however, none address the "consequences" of delivering that outcome in the first place; the risks, costs, security implications, the general lack of checks and balances. What sets the Terranetes controller apart is its opinion; we first enable the platform team to deliver the outcome in a safe environment before it can be self-served by developers. Providing platform engineers with all the knobs, dials and levers to control and mitigate those risks is the key differentiator for Terranetes controller.

Documentation can be found at https://terranetes.io

Expand All @@ -19,10 +21,10 @@ Documentation can be found at https://terranetes.io

### DEVELOPERS

- [Keep Terraform Configuration simple to use](https://terranetes.appvia.io/terranetes-controller/developer/configuration/)
- [Filter and write specific Terraform outputs to a secret](https://terranetes.appvia.io/terranetes-controller/developer/configuration/#connection-secret-reference)
- [View full Terraform log output](https://terranetes.appvia.io/terranetes-controller/developer/configuration/#viewing-the-changes)
- [Approve changes before application, supporting plan and apply workflows](https://terranetes.appvia.io/terranetes-controller/developer/configuration/#approving-a-plan)
- [Keep Terraform Configuration simple to use](https://terranetes.appvia.io/terranetes-controller/developer/provision/)
- [Filter and write specific Terraform outputs to a secret](https://terranetes.appvia.io/terranetes-controller/developer/provision/#connection-secret-reference)
- [View full Terraform log output](https://terranetes.appvia.io/terranetes-controller/developer/provision/#viewing-the-changes)
- [Approve changes before application, supporting plan and apply workflows](https://terranetes.appvia.io/terranetes-controller/developer/provision/#approving-a-plan)
- [See cost estimates prior to creating resources](https://terranetes.appvia.io/terranetes-controller/admin/costs/)
- [Support private terraform module sources](https://terranetes.appvia.io/terranetes-controller/developer/private/)
- [Directly reference FluxCD sources](https://terranetes.appvia.io/terranetes-controller/developer/flux/)
Expand All @@ -33,10 +35,15 @@ Documentation can be found at https://terranetes.io
- [Keep cloud credentials secure](https://terranetes.appvia.io/terranetes-controller/admin/providers/)
- Restrict credentials provider use via namespace and label selectors
- Don't expose credentials within a user's namespace
- [Define Guardrails around use](https://terranetes.appvia.io/terranetes-controller/admin/policy/)
- [Define Guardrails around use](https://terranetes.appvia.io/terranetes-controller/admin/policy/intro/)
- Restrict to known module sources
- Validate resource requests against Checkov policies
- Automatically inject default configuration based on labels
- [Validate your Terraform Resource Plans](https://terranetes.appvia.io/terranetes-controller/admin/cloudresource/#how-to-validate-a-revision)
- Validate the Revision syntax
- Check the specification and provide recommendations on configuration
- Scan against Checkov security policies
- [Version and publish Resource Plans](https://terranetes.appvia.io/terranetes-controller/admin/cloudresource/#what-are-revisions)

**GETTING STARTED**
---
Expand Down
Binary file added docs/images/logo-blue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logo-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit edd0dfa

Please sign in to comment.