Skip to content

Commit

Permalink
Minor changes (#143)
Browse files Browse the repository at this point in the history
* Minor changes from init branch

* remove generators
  • Loading branch information
ademariag authored Sep 2, 2023
1 parent 65b7753 commit 0c6d3ec
Show file tree
Hide file tree
Showing 27 changed files with 13 additions and 4,264 deletions.
2 changes: 1 addition & 1 deletion .kapitan
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ compile:
yaml-dump-null-as-empty: true
compose-node-name: true
refs-path: ./system/refs
jinja2-filters: ./system/lib/jinja2_filters.py
jinja2-filters: ./system/templates/jinja2_filters.py
search-paths:
- .
- ./system/
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ This repository is meant to be a way to bootstrap your [Kapitan](https://kapitan

It is meant to help you make use of best practices and libraries that can make Kapitan the ultimate tool for all your configuration needs.

Look at the branch [`init`](https://github.com/kapicorp/kapitan-reference/tree/init) for a clean setup with only the basics enabled.


## Quickstart

```shell script
Expand Down Expand Up @@ -42,7 +45,6 @@ This repo comes already with some helper tools. We will expand it as the time go

For now, you can see that the [`./kapitan`](kapitan) file is a wrapper script that allows you to run kapitan without installing any binary (it does depends on docker!)

*Note*: For speed, if kapitan is already installed, it will prefer the non-docker version.

| Script | Description |
|-----------|----------------------------------|
Expand All @@ -53,21 +55,22 @@ For now, you can see that the [`./kapitan`](kapitan) file is a wrapper script th

This repo already packs some important libraries that you will want to have when working with kapitan.

| Name | Description | Inventory file |
| ---- | ----------- | -------------- |
|kgenlib| Kapitan Generators SKD | [kgenlib.yml](inventory/classes/kapitan/kgenlib.yml)
| Name | Description | Inventory file |
|---------|------------------------|------------------------------------------------------|
| kgenlib | Kapitan Generators SKD | [kgenlib.yml](inventory/classes/kapitan/kgenlib.yml) |


Kapitan allows you to manage external dependencies like the above libraries.
### External Dependencies

This repo enables fetching by default through the ``.kapitan` file, which only fetches non existing dependencies.
Kapitan allows you to manage external dependencies like the above libraries.
This repo enables fetching by default through the `.kapitan` file, which only fetches missing dependencies.

```
```yaml
version: 0.32
compile:
prune: true
embed-refs: true
fetch: true
fetch: true # Automatically fetches missing dependencies.
```
To update them from the upstream version, force fetch by running:
Expand Down
2 changes: 1 addition & 1 deletion inventory/classes/kapitan/common.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
classes:
- kapitan.kgenlib
- kapitan.generators.kgenlib
- kapitan.generators.kubernetes
- kapitan.generators.terraform

Expand Down
File renamed without changes.
Loading

0 comments on commit 0c6d3ec

Please sign in to comment.