fack
/
kube-mate
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
better living through kubernetes
52 Commits 1 Branch 0 Tags 124 KiB
Markdown 100%
Go to file
fack cb3e6b6846 minor 2024-03-23 05:42:50 -05:00
.gitattributes Initial commit 2023-10-14 13:40:39 -05:00
.gitignore Update .gitignore 2023-12-01 23:48:00 -06:00
CHANGELOG.md copied a lot 2024-03-23 05:36:12 -05:00
CONTRIBUTING.md copied a lot 2024-03-23 05:36:12 -05:00
INFRA.md copied a lot 2024-03-23 05:36:12 -05:00
LICENSE Initial commit 2023-10-14 13:40:39 -05:00
MANIFESTO.md copied a lot 2024-03-23 05:36:12 -05:00
NOTES.md copied a lot 2024-03-23 05:36:12 -05:00
OWNERS copied a lot 2024-03-23 05:36:12 -05:00
OWNERS_ALIASES copied a lot 2024-03-23 05:36:12 -05:00
README.md copied a lot 2024-03-23 05:36:12 -05:00
SECURITY_CONTACTS copied a lot 2024-03-23 05:36:12 -05:00
TODO.md minor 2024-03-23 05:42:50 -05:00
talos-provisioning-guide.md removed trash 2024-03-23 01:28:50 -05:00

README.md

kube-mate

                                                                              |=|
                                                                             /   \
'||               '||                                     ||                |     |
 ||                ||                                     ||                |-( )-|
 || //`  '||  ||`  ||''|, .|''|, --- '||),,(|,   '''|.  ''||''  .|''|,      |kube-|
 ||<<     ||  ||   ||  || ||..||      || || ||  .|''||    ||    ||..||      |mate |
.|| \\.   `|..'|. .||..|' `|...      .||    ||. `|..||.   `|..' `|...       |-----|   
                               better    living    through    kubernetes    |_____|

Getting Started

These instructions will guide you throw both consuming and producing kube-mate. See production for notes on how to deploy the project on a live system.

Prerequisites

Computer capable of running your code.

Laptop
Desktop
Server
SoC
USFF
Refurbished Hardware

Consuming klub-mate

A step by step series of examples that tell you how to make use of klub-mate

  1. Start with your own code (skip to step #3 if you intend to use pre-packaged code)
go mod init yadda/yadda
  1. Build and publish the code within a container image
FROM scratch
COPY . .
ENTRYPOINT ["/sbin/yadda"]
EXPOSE 3000
  1. Include container image in k8s manifest
kustomize yadda yadda

  1. document your service and create a PR with your services manifest included #TODO show example of a pr that does this all.

End with an example of getting some data out of the system or using it for a little demo

Production

  1. Install kubernetes tools and set up kubernetes on your computer
  2. Create a pr to add your infra
  3. document your membership in the cluster in the table of physical infra

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • fack - Initial work - fack

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License - see the LICENSE.md file for details

Acknowledgments