updates to readme and ui text
This commit is contained in:
Родитель
57eb9356ef
Коммит
99e0dfdfa0
19
README.md
19
README.md
|
@ -2,10 +2,7 @@
|
|||
|
||||
Building a complete Kubernetes operational environment is hard work! __AKS Accelerator__ dramatically speeds up this work by providing the templates and deployment scripts to quickly create a __fully configured__, Kubernetes environment, tailored to meet your operational and security needs, ready to run your workloads in production.
|
||||
|
||||
|
||||
# Quick Start
|
||||
|
||||
All you need is access to an `Azure subscription` & a browser
|
||||
## Quick Start
|
||||
|
||||
* #### **Step 1**
|
||||
Navigate to the AKS Construction [**helper**](https://azure.github.io/AKS-Construction/)
|
||||
|
@ -16,7 +13,7 @@ All you need is access to an `Azure subscription` & a browser
|
|||
![](docs/images/helper-presets.jpg)
|
||||
<br/>
|
||||
> **Note**
|
||||
> If following Azure's **Enterprise Scale** methodology, select `Enterprise Scale` from the dropdown, then select your environment type
|
||||
> If following Azure's **Landing Zone** methodology, select `Enterprise Scale` from the dropdown, then select your environment type
|
||||
|
||||
* #### **Step 3** Fine tune (optional)
|
||||
Use the tabs to fine tune your cluster requirements
|
||||
|
@ -27,12 +24,7 @@ All you need is access to an `Azure subscription` & a browser
|
|||
|
||||
![](docs/images/helper-deploy.jpg)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
## Project components
|
||||
|
||||
### IaC - Bicep code files
|
||||
|
||||
|
@ -53,14 +45,11 @@ CI Name | Actions Workflow | Parameter file | CI Status | Notes
|
|||
|
||||
For a more in depth look at the GitHub Actions used in this project, which steps are performed and the different CI practices they demonstrate, please refer to [this page](docs/GhActions.md).
|
||||
|
||||
|
||||
|
||||
## Background
|
||||
|
||||
This project unifies guidance provided by the [AKS Secure Baseline](https://docs.microsoft.com/en-us/azure/architecture/reference-architectures/containers/aks/secure-baseline-aks), [Well Architected Framework](https://docs.microsoft.com/en-us/azure/architecture/framework/), [Cloud Adoption Framework](https://azure.microsoft.com/en-gb/cloud-adoption-framework/) and [Enterprise-Scale](https://github.com/Azure/Enterprise-Scale) by providing tangible artifacts to deploy Azure resources from CLI or CI/CD systems.
|
||||
|
||||
The AKS Bicep Accelerator is part of the official [AKS Landing Zone Accelerator (Enterprise Scale)](https://github.com/Azure/AKS-Landing-Zone-Accelerator) architectural approach. To read more about this project and how the AKS Bicep Accelerator fits with Enterprise Scale and the AKS Secure Baseline, look [here](referencearchs.md).
|
||||
|
||||
This project is part of the official [AKS Landing Zone Accelerator (Enterprise Scale)](https://github.com/Azure/AKS-Landing-Zone-Accelerator) architectural approach. To read more about this project and how the it fits with Enterprise Scale and the AKS Secure Baseline, look [here](referencearchs.md).
|
||||
|
||||
## Project Principals
|
||||
|
||||
|
|
|
@ -21,7 +21,7 @@ export function getError(array, field) {
|
|||
export const adv_stackstyle = { root: { border: "1px solid", margin: "10px 0", padding: "15px" } }
|
||||
|
||||
|
||||
export function CodeBlock({deploycmd, testId, lang, filename, error}) {
|
||||
export function CodeBlock({deploycmd, testId, lang, filename, error, hideSave}) {
|
||||
const [ copied, setCopied ] = useState(false)
|
||||
|
||||
function copyIt() {
|
||||
|
@ -39,6 +39,7 @@ export function CodeBlock({deploycmd, testId, lang, filename, error}) {
|
|||
<div key="code-header" className="codeHeader" style={{...(error && {borderColor: 'darkred'})}}>
|
||||
<span className="language">{lang}</span>
|
||||
{ error && <div className="error">{error}</div> }
|
||||
{ !hideSave &&
|
||||
<CommandBarButton
|
||||
disabled={error}
|
||||
className="action position-relative"
|
||||
|
@ -47,6 +48,7 @@ export function CodeBlock({deploycmd, testId, lang, filename, error}) {
|
|||
text={!error ? "Save" : ""}
|
||||
primaryActionButtonProps={{download: filename}}
|
||||
onClick={downloadIt}/>
|
||||
}
|
||||
<CommandBarButton
|
||||
disabled={copied || error}
|
||||
className="action position-relative"
|
||||
|
@ -57,7 +59,7 @@ export function CodeBlock({deploycmd, testId, lang, filename, error}) {
|
|||
</div>,
|
||||
|
||||
<pre key="code-pre" className="has-inner-focus" style={{...(error && {borderColor: 'darkred'})}}>
|
||||
<code className={"lang-" + lang}><span data-lang={lang} data-testid={testId || 'none'} style={{...(error && {color: 'lightgrey'})}}>{deploycmd}</span></code>
|
||||
<code className={"lang-" + lang}><span data-lang={lang} data-testid={testId || 'none'} style={{...(error && {color: 'grey'})}}>{deploycmd}</span></code>
|
||||
</pre>
|
||||
]
|
||||
}
|
||||
|
|
|
@ -392,7 +392,7 @@ az role assignment create --role "Managed Identity Operator" --assignee-principa
|
|||
</Stack.Item>
|
||||
</Stack>
|
||||
|
||||
<CodeBlock lang="shell script" error={allok ? false : 'Configuration not complete, please correct the tabs with the warning symbol before running'} deploycmd={deploycmd} testId={'deploy-deploycmd'}/>
|
||||
<CodeBlock hideSave={true} lang="shell script" error={allok ? false : 'Configuration not complete, please correct the tabs with the warning symbol before running'} deploycmd={deploycmd} testId={'deploy-deploycmd'}/>
|
||||
|
||||
{ urlParams.toString() !== "" &&
|
||||
<Text variant="medium">Not ready to deploy? Bookmark your configuration : <a href={"?" + urlParams.toString()}>here</a></Text>
|
||||
|
@ -413,7 +413,7 @@ az role assignment create --role "Managed Identity Operator" --assignee-principa
|
|||
</Stack.Item>
|
||||
</Stack>
|
||||
|
||||
<CodeBlock key="github-auth" lang="shell script" error={allok ? false : 'Configuration not complete, please correct the tabs with the warning symbol before running'} deploycmd={`# Create resource group, and an identity with contributor access that github can federate
|
||||
<CodeBlock key="github-auth" lang="shell script" hideSave={true} error={allok ? false : 'Configuration not complete, please correct the tabs with the warning symbol before running'} deploycmd={`# Create resource group, and an identity with contributor access that github can federate
|
||||
az group create -l WestEurope -n ${deploy.rg}
|
||||
|
||||
app=($(az ad app create --display-name ${ghRepo} --query "[appId,id]" -o tsv | tr ' ' "\\n"))
|
||||
|
@ -502,11 +502,9 @@ az ad sp delete --id $(az ad sp show --id \${rmId[0]} --query id -o tsv)
|
|||
|
||||
</PivotItem>
|
||||
|
||||
<PivotItem headerText="Raw Parameters File" itemKey="params" itemIcon="FileSymlink">
|
||||
|
||||
<TextField value={param_file} rows={param_file.split(/\r\n|\r|\n/).length + 1} readOnly={true} label="Parameter file" styles={{ root: { fontFamily: 'SFMono-Regular,Consolas,Liberation Mono,Menlo,Courier,monospace!important' }, field: { backgroundColor: 'lightgrey', lineHeight: '21px' } }} multiline >
|
||||
</TextField>
|
||||
|
||||
<PivotItem headerText="Parameters File" itemKey="params" itemIcon="FileSymlink">
|
||||
<Label>Can be used for source control</Label>
|
||||
<CodeBlock lang="json" deploycmd={param_file} label="Parameter file" />
|
||||
</PivotItem>
|
||||
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"defaultOps": {
|
||||
"title": "Principles driven",
|
||||
"title": "Principle driven",
|
||||
"description":"",
|
||||
"icon": "Group",
|
||||
"sections": [
|
||||
|
|
Загрузка…
Ссылка в новой задаче