Skip to content

Commit

Permalink
Delete unused Kubernetes/Helm configuration
Browse files Browse the repository at this point in the history
This commit deletes all existing documentation and configuration around
deploying cf.gov using Kubernetes and Helm. This configuration is
currently unused and will be replaced in future with an alternate
implementation (that will likely recreate some of these pieces).
  • Loading branch information
chosak committed Oct 21, 2024
1 parent 6c8ee51 commit 26193e3
Show file tree
Hide file tree
Showing 40 changed files with 14 additions and 2,042 deletions.
1 change: 0 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
!cfgov
!config
!esbuild
!helm
!requirements
!static.in
!scripts
Expand Down
37 changes: 0 additions & 37 deletions .github/workflows/k8s/docker.yml

This file was deleted.

50 changes: 0 additions & 50 deletions .github/workflows/k8s/helm_lint.yml

This file was deleted.

58 changes: 0 additions & 58 deletions .github/workflows/k8s/publish_cfgov.yml

This file was deleted.

1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.github/
.tox/
helm
cfgov/agreements/static/agreements/js/chosen.jquery.js
cfgov/agreements/static/agreements/js/jquery-3.5.1.min.js
cfgov/alerts/tests/json/
Expand Down
42 changes: 12 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,42 @@ This Django project includes the front-end assets and build tools,
code to configure our CMS, [Wagtail](https://wagtail.io/),
and several standalone Django apps for specific parts of the site.

## Documentation

Full documentation for this project is available in the [docs/](docs/) directory
and [online](https://cfpb.github.io/consumerfinance.gov/).

## Quickstart

Full installation and usage instructions are available in
[our documentation](https://cfpb.github.io/consumerfinance.gov).

This quickstart requires a working Docker Desktop installation and git:

- [Clone the repository](https://cfpb.github.io/consumerfinance.gov/installation/#clone-the-repository):

```shell
git clone https://github.com/cfpb/consumerfinance.gov.git
cd consumerfinance.gov
git clone https://github.com/cfpb/consumerfinance.gov.git
cd consumerfinance.gov
```

- One of the following runtimes:

- [Set up and run the Docker containers via docker-compose](https://cfpb.github.io/consumerfinance.gov/installation/#set-up-and-run-the-docker-containers):

```shell
docker-compose up
```

- [Set up and run the Docker containers via Kubernetes via Helm](https://cfpb.github.io/consumerfinance.gov/installation/#set-up-and-run-the-docker-containers):
- [Set up and run the Docker containers](https://cfpb.github.io/consumerfinance.gov/installation/#set-up-and-run-the-docker-containers):

```shell
./build-images.sh && ./helm-install.sh
```

if you see an error like:

```
Error: Kubernetes cluster unreachable: Get "http://localhost:8080/version": dial tcp [::1]:8080: connect: connection refused
```shell
docker-compose up
```

then you need to activate Kubernetes in your docker desktop settings!

This may take some time, as it will also
[load initial data](https://cfpb.github.io/consumerfinance.gov/installation/#load-initial-data)
and
[build the frontend](https://cfpb.github.io/consumerfinance.gov/installation/#build-the-frontend).

consumerfinance.gov should now be available at <http://localhost:8000>.

Our documentation will be available at <http://localhost:8888> (docker-compose only).
Our documentation will be available at <http://localhost:8888>.

The Wagtail admin area will be available at <http://localhost:8000/admin/>,
which you can log into with the credentials `admin`/`admin`.

## Getting the package
## Documentation

Packages are tagged into one of three groups: main Branch -> latest, PRs -> pr-#, and Release -> major.minor.patch. The github SHA of the commit packaged should be listed as a label.
To see our Docker image packages you can vist [Packages page](https://github.com/cfpb/consumerfinance.gov/pkgs/container/consumerfinance.gov)
Full documentation for this project is available in the [docs/](docs/) directory
and [online](https://cfpb.github.io/consumerfinance.gov/).

## Getting help

Expand Down
23 changes: 0 additions & 23 deletions build-images.sh

This file was deleted.

8 changes: 0 additions & 8 deletions ct.yaml

This file was deleted.

20 changes: 2 additions & 18 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,8 @@ yarn build
### Set up and run the Docker containers
consumerfinance.gov depends on PostgreSQL database and Elasticsearch.
You can use either
[`docker-compose`](https://docs.docker.com/compose/) or
[Kubernetes](https://kubernetes.io/) via [Helm](https://helm.sh/)
You can use
[`docker-compose`](https://docs.docker.com/compose/)
to run these services along side the consumerfinance.gov Django site.
To build and run our Docker containers for the first time, run:
Expand All @@ -217,21 +216,6 @@ To build and run our Docker containers for the first time, run:
docker-compose up
```
#### Kubernetes via Helm:
```shell
./build-images.sh && ./helm-install.sh
```
Either approach will build and start our
PostgreSQL, Elasticsearch, and Python services.
The first time this is run, it will
[load initial data](#load-initial-data)
and
[build the frontend](#build-the-frontend)
for you.
### Load initial data
Our `initial-data.sh` script can be used to initialize a new database to make
Expand Down
Loading

0 comments on commit 26193e3

Please sign in to comment.