Skip to content

Commit fca3877

Browse files
jbrown-xentityjbrown-xentity
authored
Merge pull request #5871 from GSA/SueValente-patch-1
Update SYSTEMS.md
2 parents df1ca9a + d46e2ce commit fca3877

2 files changed

Lines changed: 56 additions & 109 deletions

File tree

‎.gitignore‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,12 @@ output
6565

6666
# Metrics
6767
!metrics/.env
68-
metrics/*/credentials.json
68+
metrics/*/credentials.json
69+
70+
.vscode
71+
72+
# Personal Copilot tooling (local only)
73+
AGENTS.md
74+
.github/skills
75+
76+
issue-drafts/

‎SYSTEMS.md‎

Lines changed: 47 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -5,144 +5,83 @@
55

66
### Primary Codebases
77

8-
| Application/Service | Repository
9-
|---------------------------|-----------
10-
| catalog.data.gov | https://github.com/GSA/datagov-catalog
11-
| inventory.data.gov | https://github.com/GSA/inventory-app/
12-
| SSB | https://github.com/GSA/datagov-ssb/
13-
| Solr | https://github.com/GSA-TTS/datagov-brokerpak-solr
14-
| SMTP | https://github.com/GSA-TTS/datagov-brokerpak-smtp
15-
| EKS | https://github.com/GSA-TTS/datagov-brokerpak-eks
16-
| Logstack | https://github.com/GSA/datagov-logstack/
17-
| Backup-manager | https://github.com/GSA/cf-backup-manager
18-
| New Static Site | https://github.com/GSA/datagov-11ty/
19-
| Egress Proxy | https://github.com/GSA/cg-egress-proxy
20-
| CKAN User Management | https://github.com/GSA/datagov-account-management
21-
22-
### Auxiliary Codebases (also maintained by us)
23-
24-
| Application/Service | Repository
25-
|-------------------------------------------|-----------
26-
| Cloud Service Broker (development) | https://github.com/GSA/cloud-service-broker
27-
| NEW Harvesting Testing Repo | https://github.com/GSA/datagov-harvesting-logic
28-
| ckanext-datagovcatalog | https://github.com/GSA/ckanext-datagovcatalog
29-
| ckanext-datagovtheme | https://github.com/GSA/ckanext-datagovtheme
30-
| ckanext-datajson | https://github.com/GSA/ckanext-datajson
31-
| ckanext-geodatagov | https://github.com/GSA/ckanext-geodatagov
32-
| ckanext-googleanalyticsbasic | https://github.com/GSA/ckanext-googleanalyticsbasic
33-
| ckanext-qa | https://github.com/GSA/ckanext-qa
34-
| ckanext-dcat_usmetadata | https://github.com/GSA/ckanext-dcat_usmetadata
35-
| ckanext-usmetadata | https://github.com/GSA/ckanext-usmetadata
36-
| dedupe (harvesting) | https://github.com/GSA/datagov-dedupe
37-
| SSB Compliance Diagrams | https://github.com/GSA/datagov-compliance
38-
| Load testing software | https://github.com/GSA/datagov-load-testing
39-
| Terraform ALB Controller | https://github.com/GSA/terraform-kubernetes-aws-load-balancer-controller
40-
41-
### Upstream Codebases (critical to our applications)
42-
43-
| Application/Service | Repository
44-
|-----------------------------------------------|-----------
45-
| CKAN | https://github.com/ckan/ckan
46-
| ckanext-dcat | https://github.com/ckan/ckanext-dcat
47-
| ckanext-harvest | https://github.com/ckan/ckanext-harvest
48-
| ckanext-saml2auth | https://github.com/keitaroinc/ckanext-saml2auth
49-
| ckanext-report | https://github.com/ckan/ckanext-report
50-
| ckanext-archiver | https://github.com/ckan/ckanext-archiver
51-
| PyZ3950 | https://github.com/asl2/PyZ3950
52-
| ckanext-xloader | https://github.com/ckan/ckanext-xloader
53-
| ckanext-envvars | https://github.com/okfn/ckanext-envvars
54-
| docker-ckan (development) | https://github.com/okfn/docker-ckan
55-
| Cloud Service Broker (production) | https://github.com/cloudfoundry/cloud-service-broker
56-
| AWS Broker (all cloud.gov AWS-based services) | https://github.com/cloud-gov/aws-broker
57-
| Python Buildpack | https://github.com/cloudfoundry/python-buildpack
58-
| Apt Buildpack | https://github.com/cloudfoundry/apt-buildpack
59-
| NGINX Buildpack | https://github.com/cloudfoundry/nginx-buildpack
60-
| Cloudfoundry CLI | https://github.com/cloudfoundry/cli
61-
| Cloud.gov Github Actions CLI | https://github.com/cloud-gov/cg-cli-tools
62-
| SSB Github Action Terraform Deploy | https://github.com/dflook/terraform-github-actions
63-
64-
### Deprecated Codebases
65-
66-
| Application/Service | Repository
67-
|-------------------------------------------|-----------
68-
| dashboard.data.gov | https://github.com/GSA/project-open-data-dashboard/
69-
| Old Static Site | https://github.com/GSA/datagov-website/
70-
71-
### Special Mention Codebases
72-
73-
| Application/Service | Repository
74-
|-------------------------------------------|-----------
75-
| Harvester 2.0 AWS Test | https://github.com/GSA/datagov-harvester-test-aws
76-
| Harvester 2.0 Cloud.gov Test | https://github.com/GSA/datagov-harvester-test-cloudgov
8+
| Application/Service | Repository | Notes |
9+
|---------------------------|------------|-------|
10+
| catalog.data.gov | https://github.com/GSA/datagov-catalog | Current catalog -- custom Python web application |
11+
| harvest.data.gov | https://github.com/GSA/datagov-harvester | Standalone harvest pipeline |
12+
| inventory.data.gov | https://github.com/GSA/inventory-app | CKAN-based -- maintained until reprogrammed off CKAN (target winter 2026) |
13+
| www.data.gov | https://github.com/GSA/datagov-11ty |
14+
| resources.data.gov | https://github.com/GSA/resources.data.gov | Static site on cloud.gov Pages |
15+
| strategy.data.gov | https://github.com/GSA/data-strategy | Static site on cloud.gov Pages |
16+
| Egress Proxy | https://github.com/GSA/cg-egress-proxy | |
17+
| CKAN User Management | https://github.com/GSA/datagov-account-management | Repo used to help manage account add/update/delete requests for Inventory |
18+
| Logstack | https://github.com/GSA/datagov-logstack | Used to track and send all application logs to various locations |
19+
| Backup-manager | https://github.com/GSA/cf-backup-manager | Application that tracks and maintains backups for database systems for possible restoration point |
20+
21+
### Auxiliary Codebases for inventory (maintained by us for inventory.data.gov and diagrams)
22+
23+
| Application/Service | Repository |
24+
|-------------------------------------------|------------|
25+
| ckanext-datajson | https://github.com/GSA/ckanext-datajson | KEEP |
26+
| ckanext-dcat_usmetadata | https://github.com/GSA/ckanext-dcat_usmetadata | Unk. |
27+
| ckanext-usmetadata | https://github.com/GSA/ckanext-usmetadata | Unk. |
28+
| SSB Compliance Diagrams | https://github.com/GSA/datagov-compliance | KEEP |
29+
30+
### Upstream Codebases (critical to inventory.data.gov and other systems)
31+
32+
| Application/Service | Repository |
33+
|-----------------------------------------------|------------|
34+
| CKAN | https://github.com/GSA/ckan (modified from https://github.com/ckan/ckan), tag ckan-2.11.5-nosolr |
35+
| ckanext-pgsearch | https://github.com/GSA/ckanext-pgsearch |
36+
| ckanext-saml2auth | https://github.com/keitaroinc/ckanext-saml2auth |
37+
| ckanext-xloader | https://github.com/ckan/ckanext-xloader |
38+
| ckanext-envvars | https://github.com/okfn/ckanext-envvars |
39+
| ckanext-s3filestore | https://github.com/keitaroinc/ckanext-s3filestore |
40+
| Python Buildpack | https://github.com/cloudfoundry/python-buildpack |
41+
| NGINX Buildpack | https://github.com/cloudfoundry/nginx-buildpack |
42+
| Cloudfoundry CLI | https://github.com/cloudfoundry/cli |
43+
| Cloud.gov Github Actions CLI | https://github.com/cloud-gov/cg-cli-tools |
44+
7745

7846
## Applications + Services
7947

8048
### Minimum required apps
8149

8250
| App Name | Cloud.gov space | Application/Service | Deployment Code
8351
|---------------------------------------|--------------------------------------------------|---------------------------------------|---------------------
84-
| ssb-eks | management, management-staging, development-ssb | SSB-EKS | https://github.com/GSA/datagov-ssb/blob/main/application-boundary.tf @ `broker_eks`
85-
| ssb-smtp | management, management-staging, development-ssb | SSB-SMTP | ⬆️ @ `broker_smtp`
86-
| ssb-solrcloud | management, management-staging, development-ssb | SSB-Solr | ⬆️ @ `broker_solrcloud`
8752
| logstack-shipper | management, management-staging | Logstack | https://github.com/GSA/datagov-logstack/blob/main/manifest.yml
8853
| backup-manager | development, staging, prod | Backup-manager | https://github.com/GSA/cf-backup-manager/blob/main/manifest.yml
89-
| catalog-admin | development, staging, prod | catalog.data.gov | https://github.com/GSA/datagov-catalog/blob/main/manifest.yml @ `catalog-admin`
90-
| catalog-proxy | development, staging, prod | catalog.data.gov | ⬆️ @ `catalog-proxy`
91-
| catalog-fetch | development, staging, prod | catalog.data.gov | ⬆️ @ `catalog-fetch`
92-
| catalog-gather | development, staging, prod | catalog.data.gov | ⬆️ @ `catalog-gather`
93-
| catalog-web | development, staging, prod | catalog.data.gov | ⬆️ @ `catalog-web`
54+
| datagov-harvest-proxy | development, staging, prod | harvest.data.gov | https://github.com/GSA/datagov-harvester/blob/main/manifest.yml @ `((app_name))-proxy`
55+
| datagov-harvest | development, staging, prod | harvest.data.gov | https://github.com/GSA/datagov-harvester/blob/main/manifest.yml @ `((app_name))`
56+
| datagov-catalog-proxy | development, staging, prod | catalog.data.gov | https://github.com/GSA/datagov-catalog/blob/main/manifest.yml @ `((app_name))-proxy`
57+
| datagov-catalog | development, staging, prod | catalog.data.gov | https://github.com/GSA/datagov-catalog/blob/main/manifest.yml @ `((app_name))`
9458
| inventory | development, staging, prod | inventory.data.gov | https://github.com/GSA/inventory-app/blob/main/manifest.yml @ `inventory`
9559
| inventory-proxy | development, staging, prod | inventory.data.gov | ⬆️ @ `inventory-proxy`
9660
| egress-proxy-gsa-datagov-prod | prod-egress | Egress Proxy (dashboard.data.gov) | https://github.com/GSA/data.gov/blob/master/.github/workflows/enable-egress.yml
97-
| proxy-gsa-datagov-prod-catalog | prod-egress | Egress Proxy (catalog.data.gov)
98-
| egress-proxy-gsa-datagov-staging | staging-egress | Egress Proxy (dashboard.data.gov)
99-
| proxy-gsa-datagov-staging-catalog | staging-egress | Egress Proxy (catalog.data.gov)
100-
| egress-proxy-gsa-datagov-development | development-egress | Egress Proxy (dashboard.data.gov)
101-
| proxy-gsa-datagov-development-catalog | development-egress | Egress Proxy (catalog.data.gov)
10261

10362
### Apps to be deprecated
10463

10564
| App Name | Cloud.gov space | Application/Service
10665
|---------------------------|--------------------------------------------------|----------------------
10766
| www-redirects | development, staging, prod | Old Static Site
10867

68+
10969
### Minimum services
11070

11171
| Service Name | Cloud.gov space | Application/Service | Deployment Code
11272
|---------------------------|--------------------------------------------------|------------------------------------------|----------------------
11373
| backup-manager-s3 | development, staging, prod | Backup-manager | Manual (See cloud.gov [S3 Docs](https://cloud.gov/docs/services/s3/))
114-
| datagov-iam | management, management-staging, development-ssb | SSB | (not sure)
115-
| terraform-s3 | management | SSB | Manual (NEVER DELETE) (See cloud.gov [S3 Docs](https://cloud.gov/docs/services/s3/))
11674
| logstack-s3 | management, management-staging, development-ssb | Logstack | https://github.com/GSA/datagov-logstack/blob/main/create-cloudgov-services.sh
11775
| logstack-secrets | management, management-staging, development-ssb | Logstack | ⬆️
118-
| ssb-eks-db | management, management-staging, development-ssb | SSB-EKS | https://github.com/GSA/datagov-ssb/blob/main/broker/main.tf @ `cloudfoundry_service_instance.db`
119-
| ssb-smtp-db | management, management-staging, development-ssb | SSB-SMTP | ⬆️
120-
| ssb-solrcloud-db | management, management-staging, development-ssb | SSB-Solr | ⬆️
121-
| ssb-solrcloud-k8s | management, management-staging, development-ssb | SSB-Solr | https://github.com/GSA/datagov-ssb/blob/main/application-boundary.tf @ `cloudfoundry_service_instance.solrcloud_broker_k8s_cluster`
12276
| ci-deployer | ALL SPACES | \*\*Github Actions | Manual (See cloud.gov [Space Deployer Docs](https://cloud.gov/docs/services/cloud-gov-service-account/))
12377
| static-site-images | prod | New Static Site | Manual (See cloud.gov [S3 Docs](https://cloud.gov/docs/services/s3/))
12478
| sysadmin-users | development, staging, prod | catalog.data.gov, inventory.data.gov | Manual (See cloudfoundry [User-Provided Service Docs](https://docs.cloudfoundry.org/devguide/services/user-provided.html#overview))
125-
| catalog-db | development, staging, prod | catalog.data.gov | https://github.com/GSA/datagov-catalog/blob/main/create-cloudgov-services.sh
126-
| catalog-redis | development, staging, prod | catalog.data.gov | ⬆️
127-
| catalog-secrets | development, staging, prod | catalog.data.gov | ⬆️
128-
| catalog-smtp | development, staging, prod | catalog.data.gov | ⬆️
129-
| catalog-solr | development, staging, prod | catalog.data.gov | ⬆️
130-
| inventory-cdn | development, staging, prod | inventory.data.gov | Manual (See cloud.gov [External Domain Docs](https://cloud.gov/docs/services/external-domain-service/))
79+
| datagov-catalog-db | development, staging, prod | catalog.data.gov | https://github.com/GSA/datagov-catalog/blob/main/create-cloudgov-services.sh
80+
| datagov-catalog-opensearch | development, staging, prod | catalog.data.gov | https://github.com/GSA/datagov-catalog/blob/main/create-cloudgov-services.sh
81+
| datagov-catalog-secrets | development, staging, prod | catalog.data.gov | ⬆️
82+
| datagov-catalog-smtp | development, staging, prod | catalog.data.gov | ⬆️
83+
| inventory-secrets | development, staging, prod | inventory.data.gov | https://github.com/GSA/inventory-app/blob/main/create-cloudgov-services.sh |
13184
| inventory-datastore | development, staging, prod | inventory.data.gov | https://github.com/GSA/inventory-app/blob/main/create-cloudgov-services.sh
13285
| inventory-db | development, staging, prod | inventory.data.gov | ⬆️
13386
| inventory-redis | development, staging, prod | inventory.data.gov | ⬆️
13487
| inventory-s3 | development, staging, prod | inventory.data.gov | ⬆️
135-
| inventory-solr | development, staging, prod | inventory.data.gov | ⬆️
136-
137-
### Services to be deprecated
138-
139-
| Service Name | Cloud.gov space | Application/Service
140-
|---------------------------|--------------------------------------------------|----------------------
141-
| dashboard-cdn | development, staging, prod | dashboard.data.gov
142-
| dashboard-db | development, staging, prod | dashboard.data.gov
143-
| dashboard-s3 | development, staging, prod | dashboard.data.gov
144-
| dashboard-secrets | development, staging, prod | dashboard.data.gov
145-
| fcs-lifeboat | prod | \*\*FCS
146-
| www-redirects-domains | prod | Old Static Site
147-
| ami-scans | management | EKS
148-

0 commit comments

Comments
 (0)