Project

porkadot

0.0
No release in over a year
The kubernetes installer for those who want to install k8s in your home.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 2.0
~> 5.0
~> 13.0

Runtime

~> 4.1
~> 1.20
~> 1.0
= 7.0.1
 Project Readme

Porkadot

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/porkadot. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'porkadot'

And then execute:

$ bundle

Or install it yourself as:

$ gem install porkadot

Usage

TODO: Write usage instructions here

Secrets and sops

porkadot renders certificates, private keys, kubeconfigs and secret manifests into the same assets/<group>/... tree as the other assets, with mode 0600.

To keep the assets directory in git, set local.sops.enabled: true in porkadot.yaml. Secrets are then encrypted with sops (binary format) using the creation_rules of .sops.yaml next to porkadot.yaml, or of local.sops.config. They are decrypted in memory when porkadot reads them, including when it uploads them to nodes, so plain secrets are never written to the local disk.

local:
  sops:
    enabled: true

Assets rendered by older versions keep secrets in assets/secrets/. Move them with porkadot migrate-secrets --config porkadot.yaml, then run render kubelet, render etcd, render bootstrap and render kubernetes. Most commands refuse to run until the old tree is migrated.

See docs/design/sops-secrets/README.md for the design.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yuanying/porkadot.