Skip to content

Terraform module to easily connect any existing Kubernetes cluster with Gitlab

License

Notifications You must be signed in to change notification settings

lazyorangejs/terraform-gitlab-kube-cluster

Repository files navigation

README Header

Cloud Posse

terraform-gitlab-kube-cluster Latest Release

This is terraform-gitlab-kube-cluster to easily connect any existing Kubernetes cluster with Gitlab.


This project is part of our comprehensive "SweetOps" approach towards DevOps.

Terraform Open Source Modules

It's 100% Open Source and licensed under the MIT.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

Here's how to invoke this example module in your projects

data "digitalocean_kubernetes_versions" "default" {
  version_prefix = "1.16"
}

data "digitalocean_sizes" "default" {
  filter {
    key    = "memory"
    values = [2048, 3072, 4096]
  }

  filter {
    key    = "regions"
    values = ["fra1"]
  }

  sort {
    key       = "price_monthly"
    direction = "asc"
  }
}

resource "digitalocean_kubernetes_cluster" "default" {
  region = "fra1"

  name    = "examples-complete"
  version = data.digitalocean_kubernetes_versions.default.latest_version

  node_pool {
    name       = "main"
    size       = element(data.digitalocean_sizes.default.sizes, 0).slug
    node_count = 1
    min_nodes  = 1
    max_nodes  = 1
  }
}

module "example" {
  source = "../.."

  stage        = "dev"
  cluster_name = "terraform-gitlab-kube-cluster"
  dns_zone     = "terraform-gitlab-kube-cluster.example.com"

  # https://gitlab.com/lazyorangejs/lab
  root_gitlab_group = var.root_gitlab_group # should point to your own gitlab group

  kubernetes_endpoint = digitalocean_kubernetes_cluster.default.endpoint
  kubernetes_token    = digitalocean_kubernetes_cluster.default.kube_config[0].token
  kubernetes_ca_cert  = digitalocean_kubernetes_cluster.default.kube_config[0].cluster_ca_certificate
}

Examples

Here is an example of using this module:

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name Version
terraform >= 0.12.0, < 0.13.0
gitlab >= 2.10
kubernetes >= 1.11

Providers

Name Version
gitlab >= 2.10
kubernetes >= 1.11

Inputs

Name Description Type Default Required
cluster_name n/a string n/a yes
dns_zone (Required) specifies the DNS suffix for the externally-visible websites and services deployed in the cluster string n/a yes
enabled n/a bool true no
group_gitlab_runner_enabled (Optional) Setup a gitlab group runner (will be used a group runner token to set GITLAB_RUNNER_TOKEN env variable) bool false no
kubernetes_ca_cert (Required) PEM-encoded root certificates bundle for TLS authentication string n/a yes
kubernetes_endpoint (Required) The hostname (in form of URI) of Kubernetes master. string n/a yes
kubernetes_token (Required) Token of your service account, must have admin permission to create another service accounts string n/a yes
root_gitlab_group (Semi-optional) A gitlab group id attach Kubernetes cluster to string "" no
root_gitlab_project (Semi-optional) A gitlab project id attach Kubernetes cluster to string "" no
stage (Required) Stage, e.g. 'prod', 'staging', 'dev' or 'testing' string n/a yes

Outputs

No output.

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

  • root.lazyorange.xyz - A terraform configuration to setup the ready-to-go Kubernetes cluster and connect to GitLab
  • terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.

References

For additional context, refer to some of these links.

  • Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
  • Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
  • Terraform random_integer Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.
  • Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Learn More

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
  • Site Reliability Engineering. You'll have total visibility into your apps and microservices.
  • Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
  • GitOps. You'll be able to operate your infrastructure via Pull Requests.
  • Training. You'll receive hands-on training so your team can operate what we build.
  • Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
  • Troubleshooting. You'll get help to triage when things aren't working.
  • Code Reviews. You'll receive constructive feedback on Pull Requests.
  • Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

zoom

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyrights

Copyright © 2020-2020 LazyOrange, LLC

License

License: MIT

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Source: https://opensource.org/licenses/MIT

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Vitaly Markov
Vitaly Markov

README Footer Beacon