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.

Sign up for GitHub

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

Jump to bottom

update reademe - added deprecated warning for flux v1 installations #288

Merged
merged 1 commit into from
Apr 4, 2022
Merged

update reademe - added deprecated warning for flux v1 installations #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion odc_k8s/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Terraform Open Data Cube EKS Module: odc_k8s

> **:warning: Flux V1 Installations - Soon to be deprecated :warning:**
>
> This repository contains the installations for Flux Legacy, or Flux v1. Flux V1 is in [maintenance mode](https://github.com/fluxcd/flux/issues/3320)
> and will be removed from this module soon.
> Switch to [Flux V2](https://github.com/fluxcd/flux2), [Argo CD](https://github.com/argoproj/argo-cd) or other preferred GitOps tooling.

> Uninstall Flux V1, FluxCloud and HelmRelease V1 resources by passing below parameters to the module:
> ```
> flux_enabled = flase
> fluxcloud_enabled = false
> ```

Terraform ODC supporting module that provision a kubernetes core components on top of Open Data Cube EKS cluster.

#### Warning
Expand All @@ -24,7 +36,7 @@ Terraform ODC supporting module that provision a kubernetes core components on t

The module provisions the following resources:

- Install kubernetes core components - helm, flux, fluxcloud.
- Optionally install GitOps/CD tools - HelmRelease, Flux, FluxCloud
- Optionally creates a AWS CloudWatch log group to collect logs for your cluster.
- Setup `aws-auth` ConfigMap settings for user/role based cluster access.

Expand Down Expand Up @@ -163,6 +175,9 @@ module "odc_k8s" {
| tags | Additional tags - e.g. `map('StackName','XYZ')` | map(string) | {} | no |

### Inputs - FluxCD

:warning: Soon to be deprecated :warning:

| Name | Description | Type | Default | Required |
| ------ | ------------- | :----: | :-----: | :-----: |
| flux_enabled | Flag to enable flux helm release | bool | false | No |
Expand All @@ -184,6 +199,8 @@ module "odc_k8s" {

### Inputs - FluxCloud

:warning: Soon to be deprecated :warning:

| Name | Description | Type | Default | Required |
| ------ | ------------- | :----: | :-----: | :-----: |
| fluxcloud_enabled | Flag to deploy fluxcloud - used to notify flux deployment to slack | bool | false | No |
Expand Down