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

Rebrand VVA to govtool in infrastructure configuration #97

Closed
3 tasks done
placek opened this issue Feb 1, 2024 · 5 comments · Fixed by #157
Closed
3 tasks done

Rebrand VVA to govtool in infrastructure configuration #97

placek opened this issue Feb 1, 2024 · 5 comments · Fixed by #157
Assignees
@placek @pmbinapps
Labels
🏗 Infrastructure 🔩 Tech debt
Milestone
Infrastructure ma...

Comments

@placek
Copy link
Contributor

placek commented Feb 1, 2024 •
edited
Loading

Background

@adgud finished his job on the repository reorganisation. The new convention for the monorepo is to call the application govtool instead of vva, as well as to keep the backend/frontend naming instead of vva-be/vva-fe. The main places where this policy is required has been covered by @adgud PR, but there are still some spotted by @kickloop.

Acceptance Criteria

  • Make sure the infrastructure configuration (i.e. the deployment/maintenance/etc.) has no vva leftovers in the names to keep the consistency of the new convention.
  • Get rid of the suffixes like -be and -fe as they are vague.
  • Use names like: govtool, frontend, backend.

Out of scope

  1. After some conversation with @adgud we've decided to not make renaming in the terraform configuration since it will certainly require some longer downtime due to seting up new AWS instances with new names or process of renaming the infrastructure components.
  2. The tests are not to be changed, but their execution has to be confirmed with @Ryun1 since he's the author and probably the rebranding affects how the tests will run/behave.
@placek placek self-assigned this Feb 1, 2024
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update README to reflect new naming conventions
dc58e72 
This commit updates the README.md file to align with the new backend/frontend
naming convention for the SanchoNet GovTool project, as part of the ongoing
effort detailed in ticket #85. Previously, the documentation links used the old
'vva-be' and 'vva-fe' naming, which is now replaced with 'backend' and 'frontend'
respectively. This change ensures consistency across our project documentation,
following the updates made by @adgud.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update backend and frontend READMEs for naming conventions
74ef765 
This commit involves updating the README.md files for both the backend and
frontend components of the GovTool project. These changes are part of the
ongoing efforts for ticket #85, ensuring that all references to the old 'vva-be'
and 'vva-fe' codenames are replaced with the new 'backend' and 'frontend'
naming convention. This is a continuation of the work done by @adgud, aiming to
maintain consistency across the project's documentation and directory structure.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update deployment documentation to align with new naming standards
88ce9bb 
This commit updates the DEPLOY.md documentation in the docs/operations folder,
as part of the work outlined in ticket #85. The purpose of these changes is to
ensure that our deployment documentation reflects the new naming convention.

Technical Details:
- Updated the reference in the AWS setup instructions, changing the directory path
  from `./src/terraform` to `./infra/terraform`.
  This reflects the new directory structure under the 'infra' directory.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update docker compose build contexts for backend and frontend
f5a1f4f 
In this commit, we're updating the docker-compose.yml file within the
scripts/govtool directory. This is in line with the ongoing efforts for
ticket #85, focusing on aligning all parts of our project with the new
backend/frontend naming convention. This update changes the build contexts
for both the backend and frontend services in the Docker Compose configuration,
replacing the outdated paths with the new ones that reflect our current project
structure. This is an important step to ensure consistency across all our
development and deployment tools.

Technical Details:
- The build context for the 'vva-be' service in docker-compose.yml was updated
  from `vva-be` to `../../govtool/backend`.
- Similarly, the build context for the 'vva-fe' service was changed from `vva-fe`
  to `../../govtool/frontend`.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Rename backend configuration files to align with new standards
863b27f 
This commit involves renaming various configuration files related to the backend
service of the GovTool project. The change is part of the ongoing work for
ticket #85, where we're aligning all aspects of the project with the new
backend/frontend naming convention. This update specifically targets the
configuration files, changing the 'vva-be' references to 'backend'.

Technical Details:
- Renamed the configuration file from `.github/vva-be-config.json` to
  `.github/backend-config.json`.
- Updated the configuration file paths in the scripts/govtool directory, changing
  from `scripts/govtool/config/secrets/vva-be-config.json` and
  `scripts/govtool/config/secrets/vva-be-config.json.tpl` to
  `scripts/govtool/config/secrets/backend-config.json` and
  `scripts/govtool/config/secrets/backend-config.json.tpl` respectively.
- In both the `docker-compose.yml` and `docker-compose.sanchonet.yml` files,
  updated the command and secrets sections to use the new `backend-config.json`
  file. This ensures that the Docker containers for the backend service use the
  correct configuration file when deployed.
- Updated the `prepare-config.sh` script to replace the old template path with
  the new `backend-config.json.tpl`, ensuring the script correctly generates the
  required configuration files for deployment and development environments.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Rename container services in docker and grafana configurations
440384e 
This commit focuses on renaming container services in various Docker Compose
and Grafana configuration files as part of the efforts detailed in ticket #85.
The goal is to align all service names with the new backend/frontend naming
convention.

Technical Details:
- In the Grafana provisioning alerting configuration (alerting.yml), updated
  the Prometheus expression to use `backend@docker` instead of `vva-be@docker`.
  This change is crucial for accurate monitoring and alerting based on the
  new service names.
- Updated the Grafana dashboard configuration (vva.json), changing the Prometheus
  expression to reference `frontend@docker` instead of `vva-fe@docker`. This ensures
  that the dashboard accurately reflects the traffic and metrics for the frontend
  service.
- In both the `docker-compose.sanchonet.yml` and `docker-compose.yml` files,
  renamed the services from `vva-be` to `backend` and from `vva-fe` to `frontend`.
  This update affects how these services are referenced and managed within our
  Docker Compose environments, aligning them with the new project naming standards.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update traefik configuration labels for backend and frontend se…
0365f6a 
…rvices

This commit revises the Traefik configuration labels within our Docker Compose
files (docker-compose.yml and docker-compose.sanchonet.yml), as part of the
work specified in ticket #85. The aim is to replace the old 'vva-be' and 'vva-fe'
labels with 'backend' and 'frontend', in line with the new naming convention
adopted across the project.

Technical Details:
- In the `docker-compose.sanchonet.yml` file, updated all Traefik labels for
  the backend service, replacing 'vva-be' with 'backend'. This includes updates
  to router rules, middlewares, and service definitions.
- Similarly, updated the frontend service labels in the same file, changing
  'vva-fe' to 'frontend'. This change affects router rules and service
  definitions, ensuring the frontend service is correctly identified and
  routed by Traefik.
- Made analogous updates in the `docker-compose.yml` file, ensuring that local
  development environments also reflect these changes. This includes updating
  the Traefik labels for both the backend and frontend services to use the new
  service names.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update FakeDB database schema volumes in docker compose
93858c3 
This commit updates the volume mappings for the FakeDB database schema in the
docker-compose.yml file, as a part of the work detailed in ticket #85. The
modification is necessary to reflect the new backend/frontend naming convention
and directory structure in the GovTool project. Specifically, this change
ensures that the database initialization scripts for the FakeDB service are
correctly sourced from the updated locations within the project.

Technical Details:
- Changed the volume mappings for the FakeDB service within the
  docker-compose.yml file. The paths for the database initialization scripts
  'fakedbsync_users.sql' and 'schema6.sql' have been updated from
  `./vva-be/misc/...` to `../../govtool/backend/misc/...`.
- This update ensures that when the FakeDB service is started, it correctly
  locates and executes the initialization scripts stored in the new backend
  directory, maintaining the integrity and functionality of the development
  environment.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update local domain names for backend and frontend services in …
37032eb 
…docker compose

This commit changes the local domain names for the backend and frontend services
in the docker-compose.yml file, as part of the initiative in ticket #85. The
modification is aimed at aligning the local development environment with the
new backend/frontend naming convention. By updating the domain names, we ensure
that the local URLs used for accessing these services reflect the updated
project structure and naming standards.

Technical Details:
- Updated the Traefik router rule for the backend service. The local domain
  name is changed from `vva-be.localhost` to `backend-govtool.localhost`. This
  alteration is specified in the label `traefik.http.routers.backend.rule`.
- For the frontend service, updated the Traefik router rule to change its
  local domain from `vva-fe.localhost` to `frontend-govtool.localhost`. This
  change is reflected in the label `traefik.http.routers.frontend.rule`.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Rename container services in docker and grafana configurations
798894f 
This commit focuses on renaming container services in various Docker Compose
and Grafana configuration files as part of the efforts detailed in ticket #85.
The goal is to align all service names with the new backend/frontend naming
convention.

Technical Details:
- In the Grafana provisioning alerting configuration (alerting.yml), updated
  the Prometheus expression to use `backend@docker` instead of `vva-be@docker`.
  This change is crucial for accurate monitoring and alerting based on the
  new service names.
- Updated the Grafana dashboard configuration (vva.json), changing the Prometheus
  expression to reference `frontend@docker` instead of `vva-fe@docker`. This ensures
  that the dashboard accurately reflects the traffic and metrics for the frontend
  service.
- In both the `docker-compose.sanchonet.yml` and `docker-compose.yml` files,
  renamed the services from `vva-be` to `backend` and from `vva-fe` to `frontend`.
  This update affects how these services are referenced and managed within our
  Docker Compose environments, aligning them with the new project naming standards.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update traefik configuration labels for backend and frontend se…
ae4aacb 
…rvices

This commit revises the Traefik configuration labels within our Docker Compose
files (docker-compose.yml and docker-compose.sanchonet.yml), as part of the
work specified in ticket #85. The aim is to replace the old 'vva-be' and 'vva-fe'
labels with 'backend' and 'frontend', in line with the new naming convention
adopted across the project.

Technical Details:
- In the `docker-compose.sanchonet.yml` file, updated all Traefik labels for
  the backend service, replacing 'vva-be' with 'backend'. This includes updates
  to router rules, middlewares, and service definitions.
- Similarly, updated the frontend service labels in the same file, changing
  'vva-fe' to 'frontend'. This change affects router rules and service
  definitions, ensuring the frontend service is correctly identified and
  routed by Traefik.
- Made analogous updates in the `docker-compose.yml` file, ensuring that local
  development environments also reflect these changes. This includes updating
  the Traefik labels for both the backend and frontend services to use the new
  service names.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update FakeDB database schema volumes in docker compose
88b1ea2 
This commit updates the volume mappings for the FakeDB database schema in the
docker-compose.yml file, as a part of the work detailed in ticket #85. The
modification is necessary to reflect the new backend/frontend naming convention
and directory structure in the GovTool project. Specifically, this change
ensures that the database initialization scripts for the FakeDB service are
correctly sourced from the updated locations within the project.

Technical Details:
- Changed the volume mappings for the FakeDB service within the
  docker-compose.yml file. The paths for the database initialization scripts
  'fakedbsync_users.sql' and 'schema6.sql' have been updated from
  `./vva-be/misc/...` to `../../govtool/backend/misc/...`.
- This update ensures that when the FakeDB service is started, it correctly
  locates and executes the initialization scripts stored in the new backend
  directory, maintaining the integrity and functionality of the development
  environment.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Update local domain names for backend and frontend services in …
c1a2f95 
…docker compose

This commit changes the local domain names for the backend and frontend services
in the docker-compose.yml file, as part of the initiative in ticket #85. The
modification is aimed at aligning the local development environment with the
new backend/frontend naming convention. By updating the domain names, we ensure
that the local URLs used for accessing these services reflect the updated
project structure and naming standards.

Technical Details:
- Updated the Traefik router rule for the backend service. The local domain
  name is changed from `vva-be.localhost` to `backend-govtool.localhost`. This
  alteration is specified in the label `traefik.http.routers.backend.rule`.
- For the frontend service, updated the Traefik router rule to change its
  local domain from `vva-fe.localhost` to `frontend-govtool.localhost`. This
  change is reflected in the label `traefik.http.routers.frontend.rule`.
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Rename docker compose project
2222749 
This commit updates the Makefile within the scripts/govtool directory to
reflect the new project naming conventions as outlined in ticket #85. The
change involves renaming the Docker Compose project from the old 'vva' prefix
to 'govtool'. This renaming is crucial to maintain consistency throughout
the project's infrastructure and deployment scripts, aligning them with
the updated naming standards.

Technical Details:
- Modified the Docker Compose commands in the Makefile. Changed the project
  name prefix in the `-p` (project name) option from `vva-$(env)-$(cardano_network)`
  to `govtool-$(env)-$(cardano_network)`. This affects both the `deploy-stack`
  and `toggle-maintenance` targets in the Makefile.
- These changes ensure that when deploying or managing the Docker Compose
  stacks, the correct, updated project name is used, which is vital for
  proper identification and management of the containers in different
  environments.
@placek placek mentioned this issue Feb 1, 2024
Closed
placek added a commit that referenced this issue Feb 1, 2024
@placek
[#97] Rename FakeDB database name to 'govtool'
aa3262d 
This commit focuses on updating the database name for the FakeDB service from 'vva' to 'govtool'. This change is made across various configuration files and workflows as part of the efforts described in ticket #85. The update is essential to ensure that the database name aligns with the new backend/frontend naming convention and provides consistency across the project's development, testing, and deployment environments.

Technical Details:
- Updated the `backend-config.json` file in the `.github` directory and the `scripts/govtool/config/secrets` directory. Changed the 'dbname' field from 'vva' to 'govtool' in the 'fakedbsyncconfig' object.
- Modified the `.github/workflows/build-and-deploy.yml` file, updating the `FAKEDBSYNC_POSTGRES_DB` environment variable from 'vva' to 'govtool'. This change ensures that the GitHub Actions workflows utilize the correct database name during build and deployment processes.
- Changed the `FAKEDBSYNC_POSTGRES_DB` variable in the `.env.example` file in the `scripts/govtool` directory, ensuring that local development environments are correctly configured to use the new database name.
- In the `docker-compose.yml` file within the `scripts/govtool` directory, updated the `POSTGRES_DB` environment variable for the postgres service from 'vva' to 'govtool'. This ensures that the correct database is created and used when running the Docker Compose setup.
placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Add note about possible backend executable rebranding in README
7388b93 
This commit updates the README.md file in the govtool/backend directory, adding a crucial note regarding the potential renaming of the backend executable. As part of the ongoing efforts outlined in ticket #85, this note is essential to prepare for the upcoming changes that align with the project's rebranding and development strategies.

This note informs readers and developers that the executable previously known as 'vva-be' is anticipated to be officially renamed to 'govtool-backend'.  The change is in line with the project's updated branding and functional scope. It is planned to be implemented soon as part of a planned refactor
@placek
Copy link
Contributor Author

placek commented Feb 2, 2024

After yesterdays consultations with @adgud we decided to narrow the scope of that ticket since it will take too much time to complete it and will heavily affect AWS infrasructure when applied.

See Acceptance criteria.

@placek placek changed the title Rename all ocurrences of VVA codename from infrastructure configuration Rebrand VVA to govtool in infrastructure configuration Feb 2, 2024
placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Add note about possible backend executable rebranding in README
29cf8ff 
This commit updates the README.md file in the govtool/backend directory, adding a crucial note regarding the potential renaming of the backend executable. As part of the ongoing efforts outlined in ticket #85, this note is essential to prepare for the upcoming changes that align with the project's rebranding and development strategies.

This note informs readers and developers that the executable previously known as 'vva-be' is anticipated to be officially renamed to 'govtool-backend'.  The change is in line with the project's updated branding and functional scope. It is planned to be implemented soon as part of a planned refactor
@placek
Copy link
Contributor Author

placek commented Feb 2, 2024

Related PR

placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Update README to reflect new naming conventions
f80dad7 
This commit updates the README.md file to align with the new backend/frontend
naming convention for the SanchoNet GovTool project, as part of the ongoing
effort detailed in ticket #85. Previously, the documentation links used the old
'vva-be' and 'vva-fe' naming, which is now replaced with 'backend' and 'frontend'
respectively. This change ensures consistency across our project documentation,
following the updates made by @adgud.
placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Update backend and frontend READMEs for naming conventions
5315052 
This commit involves updating the README.md files for both the backend and
frontend components of the GovTool project. These changes are part of the
ongoing efforts for ticket #85, ensuring that all references to the old 'vva-be'
and 'vva-fe' codenames are replaced with the new 'backend' and 'frontend'
naming convention. This is a continuation of the work done by @adgud, aiming to
maintain consistency across the project's documentation and directory structure.
placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Update deployment documentation to align with new naming standards
899fb84 
This commit updates the DEPLOY.md documentation in the docs/operations folder,
as part of the work outlined in ticket #85. The purpose of these changes is to
ensure that our deployment documentation reflects the new naming convention.

Technical Details:
- Updated the reference in the AWS setup instructions, changing the directory path
  from `./src/terraform` to `./infra/terraform`.
  This reflects the new directory structure under the 'infra' directory.
placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Update docker compose build contexts for backend and frontend
11b1fa1 
In this commit, we're updating the docker-compose.yml file within the
scripts/govtool directory. This is in line with the ongoing efforts for
ticket #85, focusing on aligning all parts of our project with the new
backend/frontend naming convention. This update changes the build contexts
for both the backend and frontend services in the Docker Compose configuration,
replacing the outdated paths with the new ones that reflect our current project
structure. This is an important step to ensure consistency across all our
development and deployment tools.

Technical Details:
- The build context for the 'vva-be' service in docker-compose.yml was updated
  from `vva-be` to `../../govtool/backend`.
- Similarly, the build context for the 'vva-fe' service was changed from `vva-fe`
  to `../../govtool/frontend`.
placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Rename backend configuration files to align with new standards
c256452 
This commit involves renaming various configuration files related to the backend
service of the GovTool project. The change is part of the ongoing work for
ticket #85, where we're aligning all aspects of the project with the new
backend/frontend naming convention. This update specifically targets the
configuration files, changing the 'vva-be' references to 'backend'.

Technical Details:
- Renamed the configuration file from `.github/vva-be-config.json` to
  `.github/backend-config.json`.
- Updated the configuration file paths in the scripts/govtool directory, changing
  from `scripts/govtool/config/secrets/vva-be-config.json` and
  `scripts/govtool/config/secrets/vva-be-config.json.tpl` to
  `scripts/govtool/config/secrets/backend-config.json` and
  `scripts/govtool/config/secrets/backend-config.json.tpl` respectively.
- In both the `docker-compose.yml` and `docker-compose.sanchonet.yml` files,
  updated the command and secrets sections to use the new `backend-config.json`
  file. This ensures that the Docker containers for the backend service use the
  correct configuration file when deployed.
- Updated the `prepare-config.sh` script to replace the old template path with
  the new `backend-config.json.tpl`, ensuring the script correctly generates the
  required configuration files for deployment and development environments.
placek added a commit that referenced this issue Feb 2, 2024
@placek
[#97] Rename container services in docker and grafana configurations
7f721c0 
This commit focuses on renaming container services in various Docker Compose
and Grafana configuration files as part of the efforts detailed in ticket #85.
The goal is to align all service names with the new backend/frontend naming
convention.

Technical Details:
- In the Grafana provisioning alerting configuration (alerting.yml), updated
  the Prometheus expression to use `backend@docker` instead of `vva-be@docker`.
  This change is crucial for accurate monitoring and alerting based on the
  new service names.
- Updated the Grafana dashboard configuration (vva.json), changing the Prometheus
  expression to reference `frontend@docker` instead of `vva-fe@docker`. This ensures
  that the dashboard accurately reflects the traffic and metrics for the frontend
  service.
- In both the `docker-compose.sanchonet.yml` and `docker-compose.yml` files,
  renamed the services from `vva-be` to `backend` and from `vva-fe` to `frontend`.
  This update affects how these services are referenced and managed within our
  Docker Compose environments, aligning them with the new project naming standards.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update backend and frontend READMEs for naming conventions
78e0160 
This commit involves updating the README.md files for both the backend and
frontend components of the GovTool project. These changes are part of the
ongoing efforts for ticket #85, ensuring that all references to the old 'vva-be'
and 'vva-fe' codenames are replaced with the new 'backend' and 'frontend'
naming convention. This is a continuation of the work done by @adgud, aiming to
maintain consistency across the project's documentation and directory structure.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update deployment documentation to align with new naming standards
140d488 
This commit updates the DEPLOY.md documentation in the docs/operations folder,
as part of the work outlined in ticket #85. The purpose of these changes is to
ensure that our deployment documentation reflects the new naming convention.

Technical Details:
- Updated the reference in the AWS setup instructions, changing the directory path
  from `./src/terraform` to `./infra/terraform`.
  This reflects the new directory structure under the 'infra' directory.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update docker compose build contexts for backend and frontend
5b05dfa 
In this commit, we're updating the docker-compose.yml file within the
scripts/govtool directory. This is in line with the ongoing efforts for
ticket #85, focusing on aligning all parts of our project with the new
backend/frontend naming convention. This update changes the build contexts
for both the backend and frontend services in the Docker Compose configuration,
replacing the outdated paths with the new ones that reflect our current project
structure. This is an important step to ensure consistency across all our
development and deployment tools.

Technical Details:
- The build context for the 'vva-be' service in docker-compose.yml was updated
  from `vva-be` to `../../govtool/backend`.
- Similarly, the build context for the 'vva-fe' service was changed from `vva-fe`
  to `../../govtool/frontend`.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename backend configuration files to align with new standards
e908d90 
This commit involves renaming various configuration files related to the backend
service of the GovTool project. The change is part of the ongoing work for
ticket #85, where we're aligning all aspects of the project with the new
backend/frontend naming convention. This update specifically targets the
configuration files, changing the 'vva-be' references to 'backend'.

Technical Details:
- Renamed the configuration file from `.github/vva-be-config.json` to
  `.github/backend-config.json`.
- Updated the configuration file paths in the scripts/govtool directory, changing
  from `scripts/govtool/config/secrets/vva-be-config.json` and
  `scripts/govtool/config/secrets/vva-be-config.json.tpl` to
  `scripts/govtool/config/secrets/backend-config.json` and
  `scripts/govtool/config/secrets/backend-config.json.tpl` respectively.
- In both the `docker-compose.yml` and `docker-compose.sanchonet.yml` files,
  updated the command and secrets sections to use the new `backend-config.json`
  file. This ensures that the Docker containers for the backend service use the
  correct configuration file when deployed.
- Updated the `prepare-config.sh` script to replace the old template path with
  the new `backend-config.json.tpl`, ensuring the script correctly generates the
  required configuration files for deployment and development environments.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename container services in docker and grafana configurations
a7f27da 
This commit focuses on renaming container services in various Docker Compose
and Grafana configuration files as part of the efforts detailed in ticket #85.
The goal is to align all service names with the new backend/frontend naming
convention.

Technical Details:
- In the Grafana provisioning alerting configuration (alerting.yml), updated
  the Prometheus expression to use `backend@docker` instead of `vva-be@docker`.
  This change is crucial for accurate monitoring and alerting based on the
  new service names.
- Updated the Grafana dashboard configuration (vva.json), changing the Prometheus
  expression to reference `frontend@docker` instead of `vva-fe@docker`. This ensures
  that the dashboard accurately reflects the traffic and metrics for the frontend
  service.
- In both the `docker-compose.sanchonet.yml` and `docker-compose.yml` files,
  renamed the services from `vva-be` to `backend` and from `vva-fe` to `frontend`.
  This update affects how these services are referenced and managed within our
  Docker Compose environments, aligning them with the new project naming standards.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update traefik configuration labels for backend and frontend se…
e4a1d23 
…rvices

This commit revises the Traefik configuration labels within our Docker Compose
files (docker-compose.yml and docker-compose.sanchonet.yml), as part of the
work specified in ticket #85. The aim is to replace the old 'vva-be' and 'vva-fe'
labels with 'backend' and 'frontend', in line with the new naming convention
adopted across the project.

Technical Details:
- In the `docker-compose.sanchonet.yml` file, updated all Traefik labels for
  the backend service, replacing 'vva-be' with 'backend'. This includes updates
  to router rules, middlewares, and service definitions.
- Similarly, updated the frontend service labels in the same file, changing
  'vva-fe' to 'frontend'. This change affects router rules and service
  definitions, ensuring the frontend service is correctly identified and
  routed by Traefik.
- Made analogous updates in the `docker-compose.yml` file, ensuring that local
  development environments also reflect these changes. This includes updating
  the Traefik labels for both the backend and frontend services to use the new
  service names.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update FakeDB database schema volumes in docker compose
9211344 
This commit updates the volume mappings for the FakeDB database schema in the
docker-compose.yml file, as a part of the work detailed in ticket #85. The
modification is necessary to reflect the new backend/frontend naming convention
and directory structure in the GovTool project. Specifically, this change
ensures that the database initialization scripts for the FakeDB service are
correctly sourced from the updated locations within the project.

Technical Details:
- Changed the volume mappings for the FakeDB service within the
  docker-compose.yml file. The paths for the database initialization scripts
  'fakedbsync_users.sql' and 'schema6.sql' have been updated from
  `./vva-be/misc/...` to `../../govtool/backend/misc/...`.
- This update ensures that when the FakeDB service is started, it correctly
  locates and executes the initialization scripts stored in the new backend
  directory, maintaining the integrity and functionality of the development
  environment.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update local domain names for backend and frontend services in …
bd4a35e 
…docker compose

This commit changes the local domain names for the backend and frontend services
in the docker-compose.yml file, as part of the initiative in ticket #85. The
modification is aimed at aligning the local development environment with the
new backend/frontend naming convention. By updating the domain names, we ensure
that the local URLs used for accessing these services reflect the updated
project structure and naming standards.

Technical Details:
- Updated the Traefik router rule for the backend service. The local domain
  name is changed from `vva-be.localhost` to `backend-govtool.localhost`. This
  alteration is specified in the label `traefik.http.routers.backend.rule`.
- For the frontend service, updated the Traefik router rule to change its
  local domain from `vva-fe.localhost` to `frontend-govtool.localhost`. This
  change is reflected in the label `traefik.http.routers.frontend.rule`.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename docker compose project
52adc7c 
This commit updates the Makefile within the scripts/govtool directory to
reflect the new project naming conventions as outlined in ticket #85. The
change involves renaming the Docker Compose project from the old 'vva' prefix
to 'govtool'. This renaming is crucial to maintain consistency throughout
the project's infrastructure and deployment scripts, aligning them with
the updated naming standards.

Technical Details:
- Modified the Docker Compose commands in the Makefile. Changed the project
  name prefix in the `-p` (project name) option from `vva-$(env)-$(cardano_network)`
  to `govtool-$(env)-$(cardano_network)`. This affects both the `deploy-stack`
  and `toggle-maintenance` targets in the Makefile.
- These changes ensure that when deploying or managing the Docker Compose
  stacks, the correct, updated project name is used, which is vital for
  proper identification and management of the containers in different
  environments.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename FakeDB database name to 'govtool'
dd88c68 
This commit focuses on updating the database name for the FakeDB service from 'vva' to 'govtool'. This change is made across various configuration files and workflows as part of the efforts described in ticket #85. The update is essential to ensure that the database name aligns with the new backend/frontend naming convention and provides consistency across the project's development, testing, and deployment environments.

Technical Details:
- Updated the `backend-config.json` file in the `.github` directory and the `scripts/govtool/config/secrets` directory. Changed the 'dbname' field from 'vva' to 'govtool' in the 'fakedbsyncconfig' object.
- Modified the `.github/workflows/build-and-deploy.yml` file, updating the `FAKEDBSYNC_POSTGRES_DB` environment variable from 'vva' to 'govtool'. This change ensures that the GitHub Actions workflows utilize the correct database name during build and deployment processes.
- Changed the `FAKEDBSYNC_POSTGRES_DB` variable in the `.env.example` file in the `scripts/govtool` directory, ensuring that local development environments are correctly configured to use the new database name.
- In the `docker-compose.yml` file within the `scripts/govtool` directory, updated the `POSTGRES_DB` environment variable for the postgres service from 'vva' to 'govtool'. This ensures that the correct database is created and used when running the Docker Compose setup.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Add note about possible backend executable rebranding in README
99a500f 
This commit updates the README.md file in the govtool/backend directory, adding a crucial note regarding the potential renaming of the backend executable. As part of the ongoing efforts outlined in ticket #85, this note is essential to prepare for the upcoming changes that align with the project's rebranding and development strategies.

This note informs readers and developers that the executable previously known as 'vva-be' is anticipated to be officially renamed to 'govtool-backend'.  The change is in line with the project's updated branding and functional scope. It is planned to be implemented soon as part of a planned refactor
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename grafana dashboard file for GovTool stack
245f000 
This commit renames the Grafana dashboard configuration file from 'vva.json' to
'govtool.json' in the scripts/govtool/config/grafana-provisioning/dashboards
directory. This change is a continuation of the effort detailed in ticket #111,
as an extension of the issue #85, where we are updating various components
of the project to align with the new naming convention.

Technical Details:
- Renamed the Grafana dashboard configuration file from
  `scripts/govtool/config/grafana-provisioning/dashboards/vva.json` to
  `scripts/govtool/config/grafana-provisioning/dashboards/govtool.json`.
- Also updated the 'id' property of the dashboard within the file from 2 to 3.
  This change is a routine update to maintain the uniqueness and
  integrity of the dashboard's identification within the Grafana system.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update Traefik admin email in GitHub workflows
82e2eef 
This commit updates the Traefik Let's Encrypt (LE) admin email address in the
`.github/workflows/build-and-deploy.yml` file. The change is a part of the
ongoing rebranding efforts detailed in epic ticket #111, where 'vva' is being
replaced with 'govtool'. The updated email address, `admin+govtool@binarapps.com`,
reflects this rebranding, ensuring that the administrative contact for Traefik LE
certificates is consistent with the new project name.

Technical Details:
- Modified the `TRAEFIK_LE_EMAIL` environment variable in the GitHub Actions
  workflow file. Changed from `admin+vva@binarapps.com` to
  `admin+govtool@binarapps.com`. This change was made in two places within the
  file to ensure consistency across different job configurations.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update prometheus configuration for GovTool
86a36a5 
This commit updates Prometheus configuration in prepare-config.sh as part
of the ongoing efforts in rebranding epic #111.
The change is a part of the broader initiative to update all project components
to the new 'govtool' naming, ensuring consistency and clarity as the project
moves towards open-source community involvement.

Technical details:
- In the `scripts/govtool/prepare-config.sh` script, the external label for Prometheus
  monitoring has been updated from 'vva' to 'govtool'. This change ensures that
  metrics scraped by Prometheus are correctly associated with the GovTool project,
  reflecting the new project name and aiding in consistent monitoring and analytics.
.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update AWS profile name in .env.example for rebranding
a215044 
This commit updates the AWS profile name in the .env.example file within the
scripts/govtool directory, as part of the ongoing rebranding effort detailed
in ticket #111. The purpose of this change is to align the AWS configuration
with the new 'govtool' branding, replacing the old 'vva' reference.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename S3 bucket for Terraform state in AWS setup
4c05e65 
This commit updates the AWS setup for the GovTool project, particularly focusing on the Terraform configuration. The change involves renaming the S3 bucket used for storing Terraform state, aligning it with the ongoing rebranding effort detailed in ticket #111.

Technical Details:
- Updated the S3 bucket name in the `bootstrap-aws-account.sh` script within the `infra/terraform` directory. Changed from `vva-terraform-state` to `govtool-terraform-state`.
- Similarly, modified the Terraform backend configuration in `versions.tf`. The `bucket` field now uses the new `govtool-terraform-state` name.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update Terraform lock table name in AWS configuration
9b573fc 
This commit further refines the AWS configuration for the GovTool project in the `infra/terraform` directory. Following the rebranding guidelines of ticket #111, the Terraform lock table name has been updated to match the new project naming convention.

Technical Details:
- Changed the DynamoDB lock table name in the `bootstrap-aws-account.sh` script. Updated from `vva-terraform-locks` to `govtool-terraform-locks`.
- Also updated the Terraform backend configuration in `versions.tf`. The `dynamodb_table` field now references the new `govtool-terraform-locks` name.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename application components in infrastructure configuration
ca8cb48 
This commit encompasses a series of updates to the infrastructure configuration
of the GovTool project, aligning with the rebranding initiative detailed
in ticket #111. The modifications include renaming Terraform modules,
EC2 instances, and related infrastructure components from 'vva' to 'govtool'.

Technical Details:
- Updated the DEPLOY.md documentation to reference the new `govtool-ec2` module
  instead of the old `vva-ec2`.
- Renamed Terraform modules in `main.tf`. For instance, `vva-ecr-be` is now
  `govtool-ecr-backend`, and `vva-ecr-fe` is `govtool-ecr-frontend`.
- Updated various Terraform configurations, including resource names and module
  references, to reflect the new `govtool` naming.
- Renamed files and modules within the `infra/terraform/modules` directory,
  such as changing `vva-ec2` to `govtool-ec2` and updating associated files like
  `user_data.sh` and `variables.tf`.
- Adjusted the Makefile in the `scripts/govtool` directory to check for
  the renamed Terraform module `govtool-$(env)-$(cardano_network)`.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename and update backend tests for GovTool rebranding
2b73e6b 
This commit encompasses a significant update to the backend testing suite,
aligning it with the GovTool rebranding as part of ticket #111. The changes
include renaming test directories, files, and updating references within
the test cases to reflect the new project codename.

Technical Details:
- Renamed the backend testing directory from `tests/vva-be` to `tests/govtool-backend`.
- Updated `.github/workflows/test_backend.yml` to reference the new test directory and updated project URLs.
- Renamed several files within the test directory, including `.env.example`, `.gitignore`, `README.md`, `config.py`, and various test case files.
- Modified test case files to replace 'vva' references with 'govtool', ensuring the tests are correctly aligned with the updated backend application name.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rename and update integration tests for GovTool frontend
fe218b5 
This commit implements a series of changes to the integration tests for
the GovTool frontend, aligning them with the rebranding effort as outlined
in the ticket #111. The modifications include renaming test directories,
files, and updating references within the test cases to reflect the new
project codename 'govtool'.

Technical Details:
- Renamed the frontend testing directory from `tests/vva-fe` to `tests/govtool-frontend`.
- Updated `.github/workflows/test_integration_cypress.yml` to reference the new test directory and updated project URLs.
- Renamed various files within the test directory, including `.gitignore`, `README.md`, configuration files, and numerous test case files.
- Adjusted test case files to replace 'vva' references with 'govtool', ensuring the tests are accurately aligned with the updated frontend application name.
- Renamed the package in `package.json` from `vva-fe-test` to `govtool-frontend-test`.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update infrastructure tests to reflect GovTool rebranding
9b88cb3 
This commit involves updating the infrastructure tests to align with
the GovTool rebranding, as part of the work on ticket #111. The changes
include modifying various configuration files, scripts, and documentation
to replace references to the old project codename 'vva' with
the new 'govtool' codename.

Technical Details:
- Updated `.env.example` in the `tests/test-infrastructure` directory to use `STACK_NAME=govtool`.
- Revised `README.md` to reflect the new project name in the test infrastructure documentation.
- Modified `deploy-swarm.sh` script, changing comments and deployment labels to mention 'govtool' instead of 'vva'.
- Updated `docker-compose-services.yml` and `docker-compose.yml` files to use the new project name in service definitions and deployment constraints.
- Adjusted `gen-configs.sh` to generate secrets with the 'govtool' prefix, ensuring compatibility with the updated project setup.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update metrics tests to reflect GovTool rebranding
cc7875e 
This commit encompasses modifications to the metrics tests, part of the larger
effort to align all parts of the project with the GovTool rebranding,
as detailed in ticket #97. The changes include updates to configuration files
and documentation, ensuring they accurately reflect the new project codename.

Technical Details:
- Updated `.env.example` in the `tests/test-metrics-api` directory, changing `PGDATABASE='vva'` to `PGDATABASE='govtool'`.
- Revised `README.md` to update the description, indicating that the API is now associated with the GovTool app instead of 'vva'.
- These changes are critical to ensure consistency and clarity in the metrics tests, aligning them with the GovTool project's new naming conventions and ensuring accurate data logging and metrics gathering.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Rebrand load tests to align with GovTool project
d376cb2 
This commit involves a comprehensive rebranding of the load testing suite
from 'vva' to 'GovTool', as part of the ongoing efforts detailed in ticket #111.
This update ensures all aspects of the load testing, including Java class names,
Maven group and artifact IDs, and configuration settings, are consistent with
the new GovTool naming convention.

Technical Details:
- Updated Maven `pom.xml`, changing `groupId` and `artifactId` to reflect the GovTool project.
- Renamed various Java classes in the `tests/load-testing` directory from `org.cardano.vva` to `org.cardano.govtool`.
- Updated configuration files `gatling.conf` and `recorder.conf` to reflect the new project name.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update lighthouse workflow for GovTool project
8bbcbce 
This commit updates the Lighthouse workflow configuration to align with
the GovTool project rebranding, as part of the ongoing changes detailed
in ticket #111. The modifications ensure that the Lighthouse workflow
accurately references the updated project structure and naming conventions.

Technical Details:
- Revised `.github/workflows/lighthouse.yml` to use the updated paths and file references for the GovTool project.
- Adjusted the cache key in the Lighthouse workflow to reference the correct `package-lock.json` files, changing from `tests/vva-fe` to `tests/govtool-frontend`.
- Ensured that the workflow steps are properly configured to work with the new GovTool project structure.
- These changes are essential for maintaining the integrity and efficiency of the Lighthouse performance testing in the CI/CD pipeline, ensuring it reflects the current state of the GovTool project.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Update Sonar Scan workflow for GovTool frontend
b261bf7 
This commit updates the Sonar Scan workflow configuration to reflect
the new codename of the project - GovTool, as part of the restructuring
outlined in ticket #111. The changes ensure that the Sonar Scan workflow
is properly aligned with the new project name, particularly for the
frontend component of the GovTool application.

Technical Details:
- Modified `.github/workflows/frontend_sonar_scan.yml` to rename the workflow job from "Execute sonar-scanner on vva-fe" to "Execute sonar-scanner on govtool frontend".
- Ensured that the workflow steps are correctly configured to work with the GovTool frontend project.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Revert S3 and DynamoDB names for legacy infrastructure access
ef26bc4 
Summary:
This commit rolls back the names of the S3 bucket and DynamoDB table used
for Terraform state management to their original identifiers. This change is
crucial for maintaining access to our current infrastructure setup before
we proceed with renaming and rebranding efforts within our infrastructure
configuration. By reverting these names, we ensure continuity and access
to existing resources, which is necessary for a smooth transition to the
new naming convention. This step is preparatory, aimed at minimizing disruption
and maintaining operational integrity during the rebranding process.

Technical Details:
Modifications were made in Terraform configuration file, versions.tf, within the infra/terraform directory. The changes are as follows:

S3 Bucket Name: The Terraform backend configuration in versions.tf has been updated to point back to the original S3 bucket, changing from govtool-terraform-state to vva-terraform-state. This reversion ensures that Terraform commands continue to interface with the existing state file, preserving the link to our current infrastructure assets.

DynamoDB Table Name: Similarly, the DynamoDB table used for state locking has been reverted from govtool-terraform-locks to vva-terraform-locks. This change is crucial for maintaining state consistency and preventing concurrent execution conflicts during Terraform operations.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#97] Introduce migration strategy for Terraform resource renaming
cb4bace 
This commit introduces a strategic approach to renaming Terraform
resources within our AWS infrastructure, moving from the legacy codename
"VVA" to the new project identifier "GovTool". The migration is
orchestrated through the addition of two new Terraform files:
`vva_to_govtool_migration_20240212.tf` in both the main Terraform
directory and within the `govtool-ec2` module. These files serve as a
temporary mechanism to facilitate a seamless transition of resource and
module names across the infrastructure.

Key Highlights:
- The migration files outline a series of `moved` directives, explicitly
  mapping old resource and module identifiers to their new names. This
  approach ensures Terraform can manage the renaming process efficiently,
  minimizing the risk of resource duplication or loss.
- The migration is carefully planned to ensure no disruption to the
  ongoing operations, preserving the state of resources and their
  configurations throughout the process.
- A note within each migration file indicates their temporary nature,
  with instructions to remove these files once all stakeholders have
  successfully applied the migration. This step is crucial to prevent
  clutter in the Terraform codebase and maintain the integrity of the
  infrastructure as code practices. The migration files should be
  removed before project goes open source.

This renaming initiative is a critical component of our broader
rebranding efforts, reflecting the project's evolution and aligning our
infrastructure with the new brand identity.
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#171] Remove Nginx config post-deployment to prevent configuration r…
268dc91 
…euse across environments

Summary:
To enhance and fix our deployment script's reliability and ensure
environment-specific configurations are not mistakenly reused locally, this
commit introduces a critical update to the script responsible for
preparing configurations, including the Nginx setup. Recognizing the
need for distinct configurations across different deployment
environments, we've implemented a change to automatically remove the
Nginx configuration directory once the deployment script has executed.
This action prevents potential conflicts and misconfigurations when
deploying to multiple environments by ensuring that each deployment
starts with a clean slate regarding Nginx setup.

The change has been introduced after an incident[^1] occurred during
efforts on #97, where mutliple deployments on multiple environments had
to be performed avoiding the GitHub Action workflow, since they were not
yet introduced to the repository.

The problem is irrelevant on the GitHub workflows since they are
executed in isolation on containerized environment.

Technical Details:
The modification was made in the scripts/govtool/prepare-config.sh
script, where a command to remove the Nginx configuration directory
($nginx_config_dir) has been added. This line is strategically placed
before the creation of new configuration directories and files, ensuring
that any pre-existing Nginx configuration is cleared out before
generating new ones. This approach guarantees that configurations from a
previous deployment do not linger and affect subsequent deployments to
different environments. The logic specifically targets the scenario
where the deployment script is run multiple times locally across various
environments, addressing a previously overlooked aspect of our
deployment process. This change is part of our ongoing efforts to refine
our deployment practices, ensuring they are robust, clean, and tailored
to the specific requirements of each environment.
The change has no impact on GitHub workflow since the execution od the
deployment there is performed in isolation with no cached nor reused
file system storage.
Additionally the documentation note has been added to deployment
instructions to keep track of what actually happens during the deploy
process and how does this impact the target environments.

By incorporating this update, we mitigate the risk of configuration
leakage between environments, a critical aspect of maintaining the
integrity and isolation of our deployment processes. This change
underscores our commitment to continuous improvement in our deployment
strategies, ensuring they align with best practices and the unique
demands of our infrastructure.

[^1]: #174
MSzalowski pushed a commit that referenced this issue Feb 23, 2024
@placek @MSzalowski
[#203] Update Changelog for recent infrastructure updates
deb3f4a 
- Added entries for issues #85, #97, #171, and #181 in the Changelog:
  - Fixed deployment scripts to resolve Issue #171.
  - Updated Node and DbSync versions for Issue #181, enhancing system compatibility.
  - Reorganized repository structure for better alignment with new conventions, addressing Issue #85.
  - Renamed project to GovTool as part of rebranding efforts for Issue #97.
- Categorized each issue under the appropriate section: new feature, fix, or change.
- Linked each issue to its corresponding URL for detailed reference.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@placek placek

@pmbinapps pmbinapps

Labels
🏗 Infrastructure 🔩 Tech debt
Projects
Govtool all
Status: Blocked
Milestone
Infrastructure management (DevOps)
Development

Successfully merging a pull request may close this issue.

[#97] Rebrand the application in infrastructure configuration IntersectMBO/govtool
3 participants
@placek @pmbinapps @Thomas-Upfield