Skip to content

Commit

Permalink
Merge pull request #1356 from CecileRobertMichon/docs-fix
Browse files Browse the repository at this point in the history
Remove duplicated getting-started and development docs
  • Loading branch information
k8s-ci-robot authored May 6, 2021
2 parents f4704bf + c8f153c commit b246fde
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 66 deletions.
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[Roadmap](./roadmap.md)
- [Topics](./topics/topics.md)
- [Getting Started](./topics/getting-started.md)
- [Troubleshooting](./topics/troubleshooting.md)
- [AAD Integration](./topics/aad-integration.md)
- [API Server Endpoint](./topics/api-server-endpoint.md)
- [Cloud Provider Config](./topics/cloud-provider-config.md)
Expand Down
10 changes: 7 additions & 3 deletions docs/book/src/developers/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@
- [Tilt for dev in both CAPZ and CAPI](#tilt-for-dev-in-both-capz-and-capi)
- [Deploying a workload cluster](#deploying-a-workload-cluster)
- [Viewing Telemetry](#viewing-telemetry)
- [Instrumenting Telemetry](#instrumenting-telemetry)
- [Distributed Tracing](#distributed-tracing)
- [Metrics](#metrics)
- [Manual Testing](#manual-testing)
- [Creating a dev cluster](#creating-a-dev-cluster)
- [Building and pushing dev images](#building-and-pushing-dev-images)
- [Customizing the cluster deployment](#customizing-the-cluster-deployment)
- [Creating the cluster](#creating-the-cluster)
- [Instrumenting Telemetry](#instrumenting-telemetry)
- [Distributed Tracing](#distributed-tracing)
- [Metrics](#metrics)
- [Submitting PRs and testing](#submitting-prs-and-testing)
- [Executing unit tests](#executing-unit-tests)
- [Automated Testing](#automated-testing)
Expand Down Expand Up @@ -293,7 +293,10 @@ SSH_KEY_FILE=.sshkey
rm -f "${SSH_KEY_FILE}" 2>/dev/null
ssh-keygen -t rsa -b 2048 -f "${SSH_KEY_FILE}" -N '' 1>/dev/null
echo "Machine SSH key generated in ${SSH_KEY_FILE}"
# For Linux the ssh key needs to be b64 encoded because we use the azure api to set it
# Windows doesn't support setting ssh keys so we use cloudbase-init to set which doesn't require base64
export AZURE_SSH_PUBLIC_KEY_B64=$(cat "${SSH_KEY_FILE}.pub" | base64 | tr -d '\r\n')
export AZURE_SSH_PUBLIC_KEY=$(cat "${SSH_KEY_FILE}.pub" | tr -d '\r\n')
```

⚠️ Please note the generated templates include default values and therefore require the use of `clusterctl` to create the cluster
Expand Down Expand Up @@ -400,6 +403,7 @@ You can optionally set the following variables:
| `SKIP_CREATE_MGMT_CLUSTER` | Skip management cluster creation. If skipping managment cluster creation you must specify `KUBECONFIG` and `SKIP_CLEANUP` | `false` |
| `LOCAL_ONLY` | Use Kind local registry and run the subset of tests which don't require a remotely pushed controller image. | `true` |
| `REGISTRY` | Registry to push the controller image. | `capzci.azurecr.io/ci-e2e` |
| `CLUSTER_NAME` | Name of an existing workload cluster. Will run specs against existing workload cluster. Use in conjunction with `SKIP_CREATE_MGMT_CLUSTER`, `GINKGO_FOCUS` and `KUBECONFIG`. Must specify only one e2e spec to run against with `GINKGO_FOCUS` such as `export GINKO_FOCUS=Creating.a.VMSS.cluster.with.a.single.control.plane.node`. |
| `KUBECONFIG` | Used with `SKIP_CREATE_MGMT_CLUSTER` set to true. Location of kubeconfig for the management cluster you would like to use. Use `kind get kubeconfig --name capz-e2e > kubeconfig.capz-e2e` to get the capz e2e kind cluster config | '~/.kube/config' |

You can also customize the configuration of the CAPZ cluster created by the E2E tests (except for `CLUSTER_NAME`, `AZURE_RESOURCE_GROUP`, `AZURE_VNET_NAME`, `CONTROL_PLANE_MACHINE_COUNT`, and `WORKER_MACHINE_COUNT`, since they are generated by individual test cases). See [Customizing the cluster deployment](#customizing-the-cluster-deployment) for more details.
Expand Down
63 changes: 0 additions & 63 deletions docs/getting-started.md

This file was deleted.

0 comments on commit b246fde

Please sign in to comment.