Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
kchiranjewee63 committed Jun 25, 2024
1 parent 1e8f371 commit 785948e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
This directory contains Kubernetes manifest files and installation scripts for tconfigd. Below is an overview of each component:

### crd
It includes custom resource definitions(CRDs) and example custom resources(CRs) for `tratteria.io` custom resources.
This directory includes custom resource definitions(CRDs) and example custom resources(CRs) for `tratteria.io` custom resources.

### spire
It includes the Kubernetes setup for SPIRE.
This directory includes the Kubernetes setup for SPIRE.

### tconfigd
It includes the Kubernetes setup for the tconfigd server components.
This directory includes the Kubernetes setup for the tconfigd server components.

## Contribute
Contributions to the project are welcome, including feature enhancements, bug fixes, and documentation improvements.
10 changes: 5 additions & 5 deletions service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@
This directory holds the source code for tconfigd. Below is an overview of each component and its functionality.

### agentsmanager
It manages agents by enabling agent registrations, handling agent heartbeats, and tracking active agents.
This directory manages agents by enabling agent registrations, handling agent heartbeats, and tracking active agents.

### api
It implements tconfigd's APIs. It holds the following APIs:
This directory implements tconfigd's APIs. It holds the following APIs:

- Agent Registration API
- Agent Heartbeat API

### configdispatcher
It dispatches configurations to tratteria and tratteria agents.
This directory dispatches configurations to tratteria and tratteria agents.

### tratcontroller
It implements Kubernetes controller for `tratteria.io` custom resources. It hosts controllers for the following resources:
This directory implements Kubernetes controller for `tratteria.io` custom resources. It hosts controllers for the following resources:
- `tratteria.io/TraT`
- `tratteria.io/TraTExclusion`

### webhook
It implements Kubernetes Admission Controller Webhooks. It hosts the following webhooks:
This directory implements Kubernetes Admission Controller Webhooks. It hosts the following webhooks:
- Tratteria Agent Injection Mutating Admission Controller Webhook
- `tratteria.io` custom resources Validating Admission Controller Webhook

Expand Down

0 comments on commit 785948e

Please sign in to comment.