Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Update READMEs #131

Merged
merged 1 commit into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

`agent-kilt` provides a convenient way to add additional software to containers by patching ECS TaskDefinitions.



Kilt is a definition on how to include additional software inside containers. It was created to run falco in userspace
along other software. It leverages different runtimes to perform modifications to the container

Expand All @@ -29,6 +27,7 @@ is not running yet. Run time is well, you get it.
* **build.mount.image** `str` - the image that contains the volume of the mount
* **build.mount.volumes** `List(str)` - List of paths to be mounted on the target image
* **build.mount.entry_point** `List(str)` - The entry point of the image (needed for patching runtimes)

### Example
```
build {
Expand All @@ -49,13 +48,11 @@ build {
}
```



# Release

To make a new release push a new tag.

It will trigger the [release-runtime.yml](.github/workflows/release-runtimes.yml) workflow.
It will trigger the [release](.github/workflows/release.yml) workflow.

For tags, use [semver](https://semver.org/).

Expand Down
14 changes: 10 additions & 4 deletions runtimes/cloudformation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,17 @@ It installs a Cloud Formation Macro that will alter the incoming template.

## Components

* `installer` - installer for the macro
### Commands

* `cmd/handler` - the golang lambda functions powering the Macro
* `cmd/cfn-apply-kilt` - applies kilt transformation to a CFN template
* `cmd/cfn-image-info` - gets configuration for the image from repository
* `cmd/cfn-apply-kilt` - test application that applies kilt transformation to a CFN template
* `cmd/cfn-image-info` - test application that gets configuration for an image from repository

The `handler` is the main deliverable and the other applications exist to test and demo the functionality.

### Patcher

The `cfnpatcher` is a general library to apply migrations to a template.

# Usage
The installer will create a CFN macro that you can use to apply automatically
Expand All @@ -24,4 +30,4 @@ task definition:
* `"kilt-include-containers": "containerA:ContainerB"` - value is a colon separated list of
container names. Will include only some contaiers in opt-in mode
* `"kilt-ignore-containers": "containerA:containerB"` - will exclude some containers in
opt-out mode
opt-out mode
28 changes: 28 additions & 0 deletions runtimes/cloudformation/cmd/handler/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Handler

The `handler` is designed to be deployed as an AWS lambda to apply transformations to a task definition.

## Build

The `handler` uses `goreleaser` for builds and releases. The defintion can be found in `runtimes/cloudformation/.goreleaser.yml`.

*Note* to build the FIPS variant, you need to have [zig](https://github.com/ziglang/zig/wiki/Install-Zig-from-a-Package-Manager) installed.

```bash
$ cd runtimes/cloudformation
$ GORELEASER_CURRENT_TAG=0.0.1 goreleaser build --skip=validate --clean
...
$ ls -R dist/
dist/:
artifacts.json config.yaml handler metadata.json

dist/handler:
handler-fips-linux-amd64 handler-fips-linux-arm64 handler-linux-amd64 handler-linux-arm64
```

## Test

```bash
$ cd runtimes/cloudformation
$ go test -race -mod=readonly ./...
```
Loading