Skip to content

Repository Setup

The section below describes how the repositories have been set to handle multiple environments and teams with Flux V2.

There are different ways of structuring repositories as described in the Flux documentation.

Key considerations

  • Teams will deliver new features and bug fixes using trunk-based development
  • A new application repository will be created for each service/application
  • The repository structure should support multi-tenancy

Repositories

Two repositories were created to ensure the separation of core infrastructure and application deployments and manifests.

Repository Purpose
adp-flux-core This will be the main repository used for configuring GitOps.`` It will contain the manifests to deploy the core services to the AKS Cluster e.g. for secrets management
adp-flux-services This is a secondary repository that will be referenced by GitRepositories from the main repository adp-flux-core

adp-flux-core structure

The adp-flux-core contains the following top directories

  • clusters directory contains the Flux configuration per cluster.
  • infra directory contains the environment subfolders each containing base and overlays folders. Overlays are used to minimise duplication. Kustomizations are used to deploy the core services, such as Nginx Plus. The base folder for each environment will contain a list of the core services defined in the core folder that should be deployed for a specific environment. Folders 01/02 represent cluster instances within an environment. These overlay folders 01/02 contain environment specific Kustomize patches that contain the environment specific settings.
  • Core folder contains the Flux configurations (HelmRepository and HelmRelease) CRD manifests used for installing the core services
  • Services folder contains a GitRepository and Kustomization per environment that points to a path in the adp-flux-services repository. For example, the Kustomization for snd/01 will to point to the path services/environments/snd/01 in the adp-flux-services repository.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
.
├── clusters                                         # Flux configuration (cluster level) /
│   ├── snd/
│   │   └── 01/02/03/04
│   ├── dev/
│   │   └── 01/02                                           
│   ├── tst/
│   │   └── 01/02
│   ├── pre/
│   │   └── 01/02
│   └── prod/
│       └── 01/02 
├── core                                             # Core services installed in the Cluster/
│   ├── azure-service-operator
│   ├── calico
│   ├── cert-manager
│   ├── grafana
│   ├── nginx-ingress
│   └── /reloader
├── infra                                            # Flux configuration for the core services e.g. Nginx Plus/
│   ├── snd                                          # Contains infra configuration for SND core services /
│   │   ├── base                                     # References 1 or more core services to be deployed
│   │   └── 01/02                                    # Overlay containing the patches, references base
│   ├── dev/
│   │   ├── base
│   │   └── 01/02
│   ├── pre/
│   │   ├── base
│   │   └── 01/02
│   └── prod/
│       ├── base
│       └── 01/02
├── core                                            # Contains the manifests for the core service (HelmRelease, HelmRepository)/
│   ├── nginxplus                                  /
│   │   ├── nginx-ingress-chart.yaml
│   │   └── nginx-ingress-release.yaml
│   └── certmanager
└── services                                        # Flux configuration for business applications/
    ├── gitrepository.yaml                          # GitRepository resource for adp-flux-services
    ├── snd                                         # environment/
    │   └── 01                                      # environment instance number    /
    │       ├── Kustomization.yaml                  # References GitRepository, services.yaml
    │       └── services.yaml                       # This is a Kustomization file that references gitrepository.yaml and specifies the path
    ├── dev/
    │   └── 01  /
    │       ├── Kustomization.yaml
    │       └── services.yaml
    ├── pre/
    │   └── 01  /
    │       ├── Kustomization.yaml
    │       └── services.yaml
    └── prod/
        └── 01  /
            ├── Kustomization.yaml
            └── services.yaml

You can use the markdown generator tool to update the above folder structure

adp-flux-services structure

The adp-flux-core contains the following top directories

  • services directory contains the Flux configurations used for deploying the business applications.

Tenants

  • Tenants refers to the application teams that are responsible for the development of one or more business applications.
  • A unique namespace will be created for each tenant
  • All applications owned by a specific tenant on the ADP platform will be deployed to the same tenant namespace

Below is a description of the subfolders inside the services folder.

Subfolder Purpose
base the base folder contains manifests that are common to each tenant e.g. namespace, ResourceQuota and ServiceAccount. These manifests are generic, in that they have variables that can be specified at the time of onboarding.
environments This contains the environment subfolders each containing base and overlays folders. Overlays are used to minimise duplication.Kustomizations are used to deploy the business services
tenants These are the application teams 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
.
└── services/
    ├── base/
    │   └── namespace.yaml
    ├── environments/
    │   ├── snd/
    │   │   └── 01/
    │   │       └── kustomization.yaml                # references business services
    │   ├── dev/
    │   │   └── 01/02
    │   ├── pre/
    │   │   └── 01/02
    │   └── prod/
    │       └── 01/02  
    └── tenant-a                                      # Team level configuration e.g. namespace, notification/
        ├── kustomization.yaml                        # References common manifests defined in apps/base e.g. namespace.yaml
        ├── tenant-a-service1/
        │   ├── helmrelease.yaml                      # tenant a owns 1 or more services
        │   ├── helmrepository.yaml
        │   ├── snd.yaml                              # environment specific patch for snd environment
        │   ├── dev.yaml                              # environment specific patch for dev environment
        │   ├── pre.yaml                              # environment specific patch for pre environment
        │   └── prod.yaml                             # environment specific patch for prod environment
        └── tenant-b-service1/
            ├── helmrelease.yaml
            ├── helmrepository.yaml
            ├── dev.yaml
            ├── snd.yaml
            ├── pre.yaml
            └── prod.yaml

You can use the markdown generator tool to update the above folder structure