Skip to content

Commit

Permalink
docs: minor updates to dev setup guide (#812)
Browse files Browse the repository at this point in the history
* docs: remove unnecessary step for gaining access to the svc key vault

* docs: switch dir before running svc and mgmt admin-access make target
  • Loading branch information
JameelB authored Nov 6, 2024
1 parent 8112786 commit 6e1769e
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions dev-infrastructure/docs/development-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The idea of this repo is to provide means to create a development environment th
* `az login` with your Red Hat email
* Register the needed [AFEC](https://aka.ms/afec) feature flags using `cd dev-infrastructure && make feature-registration
* __NOTE:__ This will take awhile, you will have to wait until they're in a registered state.
* Your Red Hat account has been added to the ARO HCP Engineering App Developer group in Azure portal. This will give your account access to resources on Azure for development purposes. Please reach out to your manager or team lead to add you to this group.

## Infrastructure

Expand Down Expand Up @@ -97,16 +98,6 @@ Every developer creates their own set of service/management clusters, including
what: foo-bar
purpose: unkown

### Grant yourself Key Vault access

In order to access shared Service Principle credentials you need access to the Key Vault. To grant yourself access, run

```bash
az role assignment create --role "Key Vault Secrets User" --assignee $(az ad signed-in-user show --query id -o tsv) --scope $(az keyvault show --name aro-hcp-dev-svc-kv --query id -o tsv)
```

Note: you only need to run this once. Re-running it wont hurt, but it will not change anything.

### Customizing infra deployment

The basic configuration for infrastructure deployment can be found in the `config/config.yaml` file. It holds configuration key/value pairs that can be used in bicep parameter template files (`*.tmpl.bicepparam`) and Makefile config template file (`config.tmpl.mk`).
Expand Down Expand Up @@ -217,9 +208,9 @@ Please not that these kubeconfig files require an active Azure CLI session (`az
If you loose these files, you can recreate them by running

```bash
make -f dev-infrastructure/Makefile svc.aks.admin-access svc.aks.kubeconfig
make --directory=dev-infrastructure svc.aks.admin-access svc.aks.kubeconfig
or
make -f dev-infrastructure/Makefile mgmt.aks.admin-access mgmt.aks.kubeconfig
make --directory=dev-infrastructure mgmt.aks.admin-access mgmt.aks.kubeconfig
```

> Freshly granted cluster admin permissions might not be effective immediately. If you get permission denied errors on your `kubectl` commands, consider waiting a couple of minutes for the permissions to be propagated
Expand Down

0 comments on commit 6e1769e

Please sign in to comment.