Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved docs for the two modules, operator and restic
- Loading branch information
Showing
3 changed files
with
18 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Operator Support Code | ||
|
||
This Go module contains almost all of the code that supports the operator part K8up. | ||
|
||
The CLI entrypoint is in [`cmd/operator`](../cmd/operator). | ||
|
||
The rest of the operator's code follows the layout that [the _Operator SDK_](https://sdk.operatorframework.io/docs/building-operators/golang/) expects: | ||
|
||
- [`/api`](../api/v1alpha1) contains the custom resource definitions (CRDs) | ||
- [`/config`](../config) contains configuration and sample files | ||
- [`/controllers`](../controllers) contains the controllers which act on the events of the CRDs (and other events) through reconciliation loops |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Restic Backup Implementation | ||
|
||
This Go module contains the bulk of the implementation to support Restic backups. | ||
|
||
The CLI entrypoint is in [`cmd/restic`](../cmd/restic). |