Fix variable references in deployment instructions#128294
Fix variable references in deployment instructions#128294diksha-hop wants to merge 1 commit intoMicrosoftDocs:mainfrom
Conversation
|
@diksha-hop : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
prmerger-automator
bot
added
azure-data-manager-energy/svc
Change sent to author
labels
|
Learn Build status updates of commit 5431fdc: ✅ Validation status: passed
For more details, please refer to the build report. |
There was a problem hiding this comment.
Pull request overview
Updates the GCZ-on-AKS deployment guide to use consistent variable names and correct Helm/template paths, reducing copy/paste errors during deployment.
Changes:
- Fixes shell variable references (e.g., using
$AZURE_CLIENT_SECRETconsistently). - Standardizes image repo/name/tag variables to include
$prefixes. - Corrects a Helm template output path and removes an accidental duplicate YAML key; minor grammar fix.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| $AZURE_TENANT_ID="<TENANT_ID_of_target_OSDU_deployment>" # Entra ID tenant ID. Example: aaaabbbb-0000-cccc-1111-dddd2222eeee | ||
| $AZURE_CLIENT_ID="<CLIENT_ID_of_target_OSDU_deployment>" # App Registration client ID. Example: 00001111-aaaa-2222-bbbb-3333cccc4444 | ||
| $AZURE_CLIENT_SECRET="<CLIENT_SECRET_of_target_OSDU_deployment>" # App Registration client secret. Example: Aa1Bb~2Cc3.- | ||
| $CLIENT_SECRET_B64=$(echo -n "$CLIENT_SECRET" | base64 -w0) | ||
| $CLIENT_SECRET_B64=$(echo -n "$AZURE_CLIENT_SECRET" | base64 -w0) |
There was a problem hiding this comment.
The bash variable assignments are written with a leading $ (e.g., $AZURE_TENANT_ID=...), which is not valid in bash and will fail when pasted into a shell. Update these lines to use AZURE_TENANT_ID=... / AZURE_CLIENT_ID=... / AZURE_CLIENT_SECRET=... / CLIENT_SECRET_B64=... (no $ on the left-hand side).
| $GCZ_PROVIDER_IMAGE_TAG="0.28.2" | ||
| $GCZ_TRANSFORMER_IMAGE_NAME="geospatial-transformer" | ||
| $GCZ_TRANSFORMER_IMAGE_TAG="0.28.2" | ||
| PROVIDER_IMAGE_REPO=myregistry.azurecr.io/provider | ||
| PROVIDER_IMAGE_NAME=gcz-provider | ||
| PROVIDER_IMAGE_TAG=v1.0.0 | ||
| IGNITE_IMAGE_REPO=myregistry.azurecr.io/gridgain | ||
| IGNITE_IMAGE_NAME=ignite | ||
| IGNITE_IMAGE_TAG=8.9.11 | ||
| TRANSFORMER_IMAGE_REPO=myregistry.azurecr.io/transformer | ||
| TRANSFORMER_IMAGE_NAME=gcz-transformer | ||
| TRANSFORMER_IMAGE_TAG=v1.0.0 | ||
| $PROVIDER_IMAGE_REPO=myregistry.azurecr.io/provider | ||
| $PROVIDER_IMAGE_NAME=gcz-provider | ||
| $PROVIDER_IMAGE_TAG=v1.0.0 | ||
| $IGNITE_IMAGE_REPO=myregistry.azurecr.io/gridgain | ||
| $IGNITE_IMAGE_NAME=ignite | ||
| $IGNITE_IMAGE_TAG=8.9.11 | ||
| $TRANSFORMER_IMAGE_REPO=myregistry.azurecr.io/transformer | ||
| $TRANSFORMER_IMAGE_NAME=gcz-transformer | ||
| $TRANSFORMER_IMAGE_TAG=v1.0.0 |
There was a problem hiding this comment.
Same issue as above: these are shown as bash assignments but include $ on the left-hand side, which will break when executed. Remove the $ prefix for all assignment targets (keep $VAR only when referencing variables in later commands).
| ```bash | ||
| kubectl create secret generic client-secret -n ignite \ | ||
| --from-literal=clientSecret="$CLIENT_SECRET" | ||
| --from-literal=clientSecret="$AZURE_CLIENT_SECRET" |
There was a problem hiding this comment.
This line references $AZURE_CLIENT_SECRET, but earlier in the doc the variable is currently assigned using $AZURE_CLIENT_SECRET="..." (invalid bash). If the assignment isn’t corrected, this secret creation will fail because the variable won’t be set. Fix by correcting the earlier assignment syntax (no $ on the left-hand side).
| --from-literal=clientSecret="$AZURE_CLIENT_SECRET" | |
| --from-literal=clientSecret="<your-azure-client-secret>" |
|
|
||
| ```bash | ||
| $ cat > ../transformer/templates/service.yaml << EOF | ||
| $ cat > ../provider/templates/service.yaml << EOF |
There was a problem hiding this comment.
The command is shown with a leading $ prompt but also includes a leading $ before cat. In shell docs, $ should be a prompt marker, not part of the command. Remove the extra $ before cat so users can copy/paste the command successfully.
|
Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
bot
added
the
aq-pr-triaged
No description provided.