Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
shaheislamdfe committed Oct 16, 2024
1 parent 74fb52d commit 1d7d806
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,10 @@ domains:
# make qa railsc
.PHONY: railsc
railsc: get-cluster-credentials
$(if $(env), , $(error Missing <env>. Usage: "make <env> railsc"))
kubectl -n $(azure_namespace) exec -ti deployment/teaching-vacancies-$(env) -- rails c
$(eval NAMESPACE_SUFFIX=$(shell echo $(AZURE_SUBSCRIPTION) | awk -F '-' '{print $$NF}'))
@echo "Using namespace: $(NAMESPACE_SUFFIX)"
@echo "Environment: $(CONFIG)"
kubectl -n tra-$(NAMESPACE_SUFFIX) exec -ti deployment/access-your-teaching-qualifications-$(CONFIG) -- rails c

bin/konduit.sh:
curl -s https://raw.githubusercontent.com/DFE-Digital/teacher-services-cloud/main/scripts/konduit.sh -o bin/konduit.sh \
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,14 +226,14 @@ The review app needs to be deployed first. You can do this manually by tagging a

### Updating keyvault secrets

Updating keyvault secrets is a manual process, the resource can be found in
Updating keyvault secrets is a manual process which will require elevated permissions via PIM for production access to Azure resources, the resource can be found in:


```
Review: s189t01-aytq-rv-app-kv
Test: s189t01-aytq-ts-app-kv
Preproduction: s189t01-aytq-pp-inf-kv
Produciton: s189p01-aytq-pd-app-kv
Production: s189p01-aytq-pd-app-kv
```

## Licence
Expand Down
4 changes: 3 additions & 1 deletion docs/review_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Both services are accessible at the single URL. By default, the base path will r

In order to deploy a review app you can either use the make target or raise a pull request and label the deployment with 'deploy-aks' and this will trigger the GHA workflow to deploy the review app based on the branch name.

This will then create a URL for testing and to destroy the review app you close the pull request which will trigger the delete workflow. Further details for this can be found in the github workflow build-and-deploy.yml aswell as the deploy-environment/action.yml
This will then create a URL for testing and to destroy the review app when you close the pull request which will trigger the delete workflow. Further details for this can be found in the github workflow build-and-deploy.yml as well as the deploy-environment/action.yml.

Note that review apps have container based Postgres and Redis volumes. The data will not persist once the review app has been destroyed.

## Authentication

Expand Down

0 comments on commit 1d7d806

Please sign in to comment.