Giter VIP home page Giter VIP logo

oci-tf-template-repo's Introduction

Hi there 👋

My name is Çetin, kral2 is my online alter ego.

I work at HashiCorp as a Solution Architect. TL;DR - I am a "learn it all" kind of person, and always eager to share back 😄

Before joining HashiCorp, I was focused on anything related to Oracle Cloud Infrastructure, with a big emphasising on automation. My favorite tools for the task were Terraform, Packer and Ansible, while morphing into Pythonista mode when things gets serious.

When I don't craft things, I draw boxes and lines on (virtual) whiteboards. Eventually with some smiling clouds.

My previous areas of expertise are mainly around Data Center/Infrastructure stuff (Systems, Virtualization, Storage, Networking, HCI) and End-User Computing. This is reflected in my certification graveyard: VMware (VCP-DCV x3), Citrix (CCIA/CCE-V) & Cisco (CCNP DC) are amongst the tombstones you can see. Other certifications precedes the online badges trend and will receive no love in this world.

Follow @kraltwo on Twitter cetinardal | Acclaim cetinardal | LinkedIn

oci-tf-template-repo's People

Contributors

kral2 avatar

Watchers

avatar avatar

Forkers

bridgecrew-perf4

oci-tf-template-repo's Issues

Make `remote-backend.tf` optional

Let's comment the content of this file, so a freshly cloned repo will be functional immediately, without any preparatory work related to the declared S3 backend.

remote-backend.tf will not be enforced anymore, but will be there just as an optional boilerplate. The template repo user can choose to keep Terraform statefile locally, or configure another remote backend.

  • comment remote-backend.tf and update its content to explain the "optional" usage logic
  • update README information

Autogenerate README TOC

README is using terraform-docs to autogenerate terraform related information (inputs, variables, ouputs, requirements).

The Table of Content requires manual updates. Project like md-toc would solve the problem.

Create an init script

Once the template repo is cloned, there is some work left to the user to make the most of it:

  • install any prerequisite,
  • initialize tooling (pre-commit),
  • setup any infrastructure required for remote-backend

An idea, is to create a install script that would be part of the repo and when executed, would take care of all theses tasks.

Move template repo related doc

The current template repo readme contains all the information related to the template usage. This can add noise when starting a fresh new repo.

The idea is to have a minimal README that can be quickly cleaned up, and adding a link to the template repo usage.

  • move repo related doc under /doc
  • create a minimal README, with a link to the full doc
  • same approach for CHANGELOG.md

Update README

README have some outdated information that needs to be updated. Some instructions on how to use this repo also needs to be revisited as the gh command line tool now have fixed some old bugs.

"Requirement" section

  • Give some pointers about how to satisfy the requirements. Maybe build an automated install script?

"how to use" section

  • give exact command on how to clone this repo
  • adjust backend related message to suggest it is optional

"Features" section

  • give some basic information about pre-commit, e.g. the fact that you need to initialize it before it becomes active
  • review "tf config fiels" sub-section, some outdated information over there.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.