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.

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

Added known issues and a session of when to use #3737

Merged
merged 5 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions docs/deploy-development-rp.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,31 @@
# Deploy development RP

## Why to use it?
This is the **preferred** and fast way to have your own local development RP setup, while also having a functional cluster.
It uses hacks scripts around a lot of the setup to make things easier to bootstrap and be more sensible for running off of your local laptop.

- Check the specific use-case examples where [deploying full RP service](https://github.com/Azure/ARO-RP/blob/master/docs/deploy-full-rp-service-in-dev.md) can be a better match.

## Prerequisites

1. Your development environment is prepared according to the steps outlined in [Prepare Your Dev Environment](./prepare-your-dev-environment.md)

## Installing the extension

1. Build the development `az aro` extension:
1. Check the `env.example` file and copy it by creating your own:

```bash
cp env.example env
```

2. Build the development `az aro` extension:
ehvs marked this conversation as resolved.
Show resolved Hide resolved

```bash
. ./env
make az
```

1. Verify the ARO extension is registered:
3. Verify the ARO extension is registered:

```bash
az -v
Expand Down Expand Up @@ -421,3 +433,12 @@ To run fake metrics socket:
```bash
go run ./hack/monitor
```

## Troubleshooting

1. Trying to use `az aro` CLI in Production, fails with:
```
(NoRegisteredProviderFound) No registered resource provider found for location '$LOCATION' and API version '2024-08-12-preview'
```
- Check if`~/.azure/config` there is a block `extensions.dev_sources`. If yes, comment it.
- Check if env var `AZURE_EXTENSION_DEV_SOURCES` is set. If yes, unset it.
9 changes: 8 additions & 1 deletion docs/deploy-full-rp-service-in-dev.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Deploy an Entire RP Development Service
# Deploy an entire RP Development Service

## When to use it?

- Test the gateway and clusters' interactions with it.
- Test the actual VMSS instances we run the RP and gateway on.
- Test our deployments (since full-service uses mostly the same deployment setup as production).
- Test any Hive cluster changes without messing with the shared development Hive clusters.

## Prerequisites

Expand Down
Loading