Skip to content

Commit

Permalink
Fixed some spelling issues, broken link checker, and default build te…
Browse files Browse the repository at this point in the history
…mplate version (#635)

* Fixed some spelling issues

* Added spelling exception

* Updated link to Cloud Shell to fix validation error

* Reverting default template to 0.10.0

* Added lycheeignore to exclude certain sites from broken link checking

* Renamed ignore file

* Corrected final reference to getCreds
  • Loading branch information
pjlewisuk committed Aug 14, 2023
1 parent d36711c commit cfbe55e
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/AKSC_Deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
templateVersion:
description: 'Template Version'
required: false
default: '0.10.0-preview'
default: '0.10.0'
type: string
rg:
description: 'Resource Group name'
Expand Down
3 changes: 3 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
http://shell.azure.com
https://shell.azure.com
https://portal.azure.com/#cloudshell/
1 change: 1 addition & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
"demoapp",
"denydefault",
"deploycmd",
"deployparams",
"deploystr",
"DNAT",
"dnsname",
Expand Down
18 changes: 9 additions & 9 deletions helper/src/components/deployTab.js
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ export default function DeployTab({ defaults, updateFn, tabValues, invalidArray,
const displayPostCmd =
Object.keys(post_params).length >0 || (!deploy.disablePreviews && Object.keys(preview_post_params).length >0)

const getCredentials =
const displayGetCredentials =
'# Get credentials for your new AKS cluster & login (interactive)\n' +
`az aks get-credentials -g ${deploy.rg} -n ${aks}\n` +
'kubectl get nodes'
Expand All @@ -273,8 +273,8 @@ export default function DeployTab({ defaults, updateFn, tabValues, invalidArray,
`\n"${deploy.selectedTemplate === "local" ? ' --file ./postdeploy/scripts/postdeploy.sh --file ./postdeploy/helm/Az-CertManagerIssuer-0.3.0.tgz --file ./postdeploy/k8smanifests/networkpolicy-deny-all.yml --file ./helper/src/dependencies.json' : ''}`

const post_deployBASHstr = cluster.apisecurity !== "private" ?
(deploy.getCreds || displayPostCmd ?
getCredentials + (displayPostCmd ? post_deployBASHcmd : '')
(deploy.getCredentials || displayPostCmd ?
displayGetCredentials + (displayPostCmd ? post_deployBASHcmd : '')
:
'')
:
Expand All @@ -297,7 +297,7 @@ export default function DeployTab({ defaults, updateFn, tabValues, invalidArray,
return ` \\\n\t${k}=${targetVal}`
}).join('') +
'\n\n' +
(displayPostCmd || deploy.getCreds ? post_deployBASHstr : '')
(displayPostCmd || deploy.getCredentials ? post_deployBASHstr : '')

//Powershell (Remember to align any changes with Bash)
const preview_post_deployPScmd = Object.keys(preview_post_params).map(k => {
Expand All @@ -317,8 +317,8 @@ export default function DeployTab({ defaults, updateFn, tabValues, invalidArray,
(!deploy.disablePreviews ? preview_post_deployPScmd : '')

const post_deployPSstr = cluster.apisecurity !== "private" ?
(deploy.getCreds || displayPostCmd ?
getCredentials + (displayPostCmd ? post_deployPScmd : '')
(deploy.getCredentials || displayPostCmd ?
displayGetCredentials + (displayPostCmd ? post_deployPScmd : '')
:
'')
:
Expand All @@ -335,7 +335,7 @@ export default function DeployTab({ defaults, updateFn, tabValues, invalidArray,
return ` \`\n\t${k}=${targetVal}`
}).join('') +
'\n\n' +
(displayPostCmd || deploy.getCreds ? post_deployPSstr : '')
(displayPostCmd || deploy.getCredentials ? post_deployPSstr : '')

//Terraform
const deployTfcmd = `#download the *.tf files and run these commands to deploy using terraform\n#for more AKS Construction samples of deploying with terraform, see https://aka.ms/aksc/terraform\n\nterraform fmt\nterraform init\nterraform validate\nterraform plan -out main.tfplan\nterraform apply main.tfplan\nterraform output`
Expand Down Expand Up @@ -467,7 +467,7 @@ az role assignment create --role "Managed Identity Operator" --assignee-principa

<Label>Always retrieve cluster credentials & login (interactive)</Label>
<Stack.Item>
<Checkbox disabled={cluster.apisecurity === "private" || displayPostCmd} checked={deploy.getCreds || displayPostCmd} onChange={(ev, v) => updateFn("getCreds", v)} label="Always show the 'az aks get-credentials' command to quickly connect to your new cluster" />
<Checkbox disabled={cluster.apisecurity === "private" || displayPostCmd} checked={deploy.getCredentials || displayPostCmd} onChange={(ev, v) => updateFn("getCredentials", v)} label="Always show the 'az aks get-credentials' command to quickly connect to your new cluster" />
</Stack.Item>

<Label>Telemetry</Label>
Expand Down Expand Up @@ -501,7 +501,7 @@ az role assignment create --role "Managed Identity Operator" --assignee-principa
<Stack.Item>
<Label >Commands to deploy your fully operational environment</Label>
<Text>
Requires <Link target="_bl" href="https://docs.microsoft.com/cli/azure/install-azure-cli">AZ CLI (2.37.0 or greater)</Link>, or execute in the <Link target="_cs" href="http://shell.azure.com/">Azure Cloud Shell</Link>.
Requires <Link target="_bl" href="https://docs.microsoft.com/cli/azure/install-azure-cli">AZ CLI (2.37.0 or greater)</Link>, or execute in the <Link target="_cs" href="https://portal.azure.com/#cloudshell/">Azure Cloud Shell</Link>.
</Text>
</Stack.Item>

Expand Down
2 changes: 1 addition & 1 deletion helper/src/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"githubrepobranch": "main",
"deployItemKey": "deployArmCli",
"workloadDeployCommands" : [],
"getCreds" : true
"getCredentials" : true
},
"cluster": {
"keyVaultKmsByoRG": "",
Expand Down

0 comments on commit cfbe55e

Please sign in to comment.