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

fix output scirpts #237

Merged
merged 3 commits into from
Mar 25, 2022
Merged

fix output scirpts #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f57ab5
fix output scirpts
yiliuTo Mar 25, 2022
d0f942d
address comments and update migration guide
yiliuTo Mar 25, 2022
1585069
Update setup_env.sh
saragluna Mar 25, 2022
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
4 changes: 4 additions & 0 deletions ...spring-cloud-azure-starter-integration-servicebus/multiple-namespaces/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ Outputs:

AZURE_SERVICEBUS_NAMESPACE_01 = "${YOUR_SERVICEBUS_NAMESPACE_01}"
AZURE_SERVICEBUS_NAMESPACE_02 = "${YOUR_SERVICEBUS_NAMESPACE_02}"
AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME = "${YOUR_AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME}"
AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME = "${YOUR_AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME}"
```

You can go to [Azure portal](https://ms.portal.azure.com/) in your web browser to check the resources you created.
Expand All @@ -130,6 +132,8 @@ If you want to run the sample in debug mode, you can save the output value.
```shell
AZURE_SERVICEBUS_NAMESPACE_01=...
AZURE_SERVICEBUS_NAMESPACE_02=...
AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME=...
AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME=...
```

## Run Locally
Expand Down
75 changes: 72 additions & 3 deletions ...oud-azure-starter-integration-servicebus/multiple-namespaces/migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,91 @@ Legacy properties | Modern properties | Comment
servicebus.producers[0].entity-name | my.servicebus.namespaces[0].entity-name | The name of queue1 in namespace1.
servicebus.producers[0].entity-type | my.servicebus.namespaces[0].entity-type | The entity type of queue1, should be set as `queue`.
servicebus.producers[0].namespace | my.servicebus.namespaces[0].namespace | The name of namespace1.
servicebus.producers[0].connection-string | my.servicebus.namespaces[0].connection-string | The connection string of namespace1.
servicebus.producers[0].credential.client-id | my.servicebus.namespaces[0].credential.client-id | The client id of the security principal to connect to queue1.
servicebus.producers[0].credential.client-secret | my.servicebus.namespaces[0].credential.client-secret | The client secret of the security principal to connect to queue1.
servicebus.producers[0].profile.tenant-id | my.servicebus.namespaces[0].profile.tenant-id | The tenant id of the security principal to connect to queue1.
servicebus.producers[0].profile.tenant-id | my.servicebus.namespaces[0].profile.tenant-id | The tenant id of the security principal to connect to queue1.
servicebus.producers[0].profile.managed-identity-client-id | my.servicebus.namespaces[0].credential.client-id | The client id of the managed identity to connect to queue1, only needed when using a user-assigned managed identity.
N/A | my.servicebus.namespaces[0].credential.managed-identity-enabled | Whether to enable using the managed identity for authentication.
servicebus.producers[1].entity-name | my.servicebus.namespaces[1].entity-name | The name of queue2 in namespace2.
servicebus.producers[1].entity-type | my.servicebus.namespaces[1].entity-type | The entity type of queue2, should be set as `queue`.
servicebus.producers[1].namespace | my.servicebus.namespaces[1].namespace | The name of namespace2.
servicebus.producers[1].connection-string | my.servicebus.namespaces[1].connection-string | The connection string of namespace2.
servicebus.producers[1].credential.client-id | my.servicebus.namespaces[1].credential.client-id | The client id of the security principal to connect to queue2.
servicebus.producers[1].credential.client-secret | my.servicebus.namespaces[1].credential.client-secret | The client secret of the security principal to connect to queue2.
servicebus.producers[1].profile.tenant-id | my.servicebus.namespaces[1].profile.tenant-id | The tenant id of the security principal to connect to queue2.
servicebus.producers[1].profile.tenant-id | my.servicebus.namespaces[1].profile.tenant-id | The tenant id of the security principal to connect to queue2.
servicebus.producers[1].profile.managed-identity-client-id | my.servicebus.namespaces[1].credential.client-id | The client id of the managed identity to connect to queue2, only needed when using a user-assigned managed identity.
N/A | my.servicebus.namespaces[1].credential.managed-identity-enabled | Whether to enable using the managed identity for authentication.
servicebus.processors[0].entity-name | my.servicebus.namespaces[0].entity-name | The name of queue1 in namespace1. Can be neglected since configured in the above properties.
servicebus.processors[0].entity-type | my.servicebus.namespaces[0].entity-type | The entity type of queue1, should be set as `queue`. Can be neglected since configured in the above properties.
servicebus.processors[0].namespace | my.servicebus.namespaces[0].namespace | The name of namespace1. Can be neglected since configured in the above properties.
servicebus.processors[0].connection-string | my.servicebus.namespaces[0].connection-string | The connection string of namespace1. Can be neglected since configured in the above properties.
servicebus.processors[0].credential.client-id | my.servicebus.namespaces[0].credential.client-id | The client id of the security principal to connect to queue1. Can be neglected since configured in the above properties.
servicebus.processors[0].credential.client-secret | my.servicebus.namespaces[0].credential.client-secret | The client secret of the security principal to connect to queue1. Can be neglected since configured in the above properties.
servicebus.processors[0].profile.tenant-id | my.servicebus.namespaces[0].profile.tenant-id | The tenant id of the security principal to connect to queue1. Can be neglected since configured in the above properties.
servicebus.processors[0].profile.tenant-id | my.servicebus.namespaces[0].profile.tenant-id | The tenant id of the security principal to connect to queue1. Can be neglected since configured in the above properties.
servicebus.processors[0].profile.managed-identity-client-id | my.servicebus.namespaces[0].credential.client-id | The client id of the managed identity to connect to queue1, only needed when using a user-assigned managed identity. Can be neglected since configured in the above properties
N/A | my.servicebus.namespaces[0].credential.managed-identity-enabled | Whether to enable using the managed identity for authentication. Can be neglected since configured in the above properties

### Configuration migration based on the usage of connection strings

When using connection string to connect to Azure Service Bus, the configuration should be changed to

```yaml
my.servicebus.namespaces[0]:
connection-string: ${AZURE_SERVICEBUS_CONNECTION_STRING_01}
entity-type: queue
entity-name: ${AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME}
my.servicebus.namespaces[1]:
connection-string: ${AZURE_SERVICEBUS_CONNECTION_STRING_02}
entity-type: queue
entity-name: ${AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME}
```

### Configuration migration based on the usage of service principals

When using service principals to connect to Azure Service Bus, the configuration should be changed to

```yaml
my.servicebus.namespaces[0]:
namespace: ${AZURE_SERVICEBUS_NAMESPACE_01}
credential:
client-id: ${AZURE_CLIENT_ID_01}
client-secret: ${AZURE_CLIENT_SECRET_01}
profile:
tenant-id: ${AZURE_TENANT_ID_01}
entity-type: queue
entity-name: ${AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME}
my.servicebus.namespaces[1]:
namespace: ${AZURE_SERVICEBUS_NAMESPACE_02}
credential:
client-id: ${AZURE_CLIENT_ID_02}
client-secret: ${AZURE_CLIENT_SECRET_02}
profile:
tenant-id: ${AZURE_TENANT_ID_02}
entity-type: queue
entity-name: ${AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME}
```

### Configuration migration based on the usage of managed identities

When using managed identities to connect to Azure Service Bus, the configuration should be changed to

```yaml
my.servicebus.namespaces[0]:
namespace: ${AZURE_SERVICEBUS_NAMESPACE_01}
credential:
client-id: ${AZURE_CLIENT_ID_01}
managed-identity-enabled: true
entity-type: queue
entity-name: ${AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME}
my.servicebus.namespaces[1]:
namespace: ${AZURE_SERVICEBUS_NAMESPACE_02}
credential:
client-id: ${AZURE_CLIENT_ID_02}
managed-identity-enabled: true
entity-type: queue
entity-name: ${AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME}
```
## Code changes

This section introduces how to migrate the code of legacy samples.
Expand Down
6 changes: 6 additions & 0 deletions ...ng-cloud-azure-starter-integration-servicebus/multiple-namespaces/terraform/setup_env.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
$env:AZURE_SERVICEBUS_NAMESPACE_01=$(terraform -chdir=terraform output -raw AZURE_SERVICEBUS_NAMESPACE_01)
$env:AZURE_SERVICEBUS_NAMESPACE_02=$(terraform -chdir=terraform output -raw AZURE_SERVICEBUS_NAMESPACE_02)

$env:AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME=$(terraform -chdir=terraform output -raw AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME)
$env:AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME=$(terraform -chdir=terraform output -raw AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME)

echo AZURE_SERVICEBUS_NAMESPACE_01=$env:AZURE_SERVICEBUS_NAMESPACE_01
echo AZURE_SERVICEBUS_NAMESPACE_02=$env:AZURE_SERVICEBUS_NAMESPACE_02

echo AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME=$env:AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME
echo AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME=$env:AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME
6 changes: 6 additions & 0 deletions ...ing-cloud-azure-starter-integration-servicebus/multiple-namespaces/terraform/setup_env.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
export AZURE_SERVICEBUS_NAMESPACE_01=$(terraform -chdir=./terraform output -raw AZURE_SERVICEBUS_NAMESPACE_01)
export AZURE_SERVICEBUS_NAMESPACE_02=$(terraform -chdir=./terraform output -raw AZURE_SERVICEBUS_NAMESPACE_02)

export AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME=$(terraform -chdir=./terraform output -raw AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME)
export AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME=$(terraform -chdir=./terraform output -raw AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME)

echo AZURE_SERVICEBUS_NAMESPACE_01=$AZURE_SERVICEBUS_NAMESPACE_01
echo AZURE_SERVICEBUS_NAMESPACE_02=$AZURE_SERVICEBUS_NAMESPACE_02

echo AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME=$AZURE_SERVICEBUS_NAMESPACE_01_QUEUE_NAME
echo AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME=$AZURE_SERVICEBUS_NAMESPACE_02_QUEUE_NAME