Add documentation for autoscaler
Overview
This is a new project to provide Windows Autoscaling VMS which is a custom executor driver. This driver has a good amount of documentation needed:
- How to configure it using the custom executor
- General configuration
- Configuration specific for GCP
- Best practices
- How to use it
Apart from that list we also plan to add more cloud providers, for example, Azure, so we would need to add more documentation in the future, and most likely we also plan to add Docker support in the future.
Proposal
How
As discussed in https://gitlab.com/gitlab-org/ci-cd/custom-executors/autoscaler/issues/14#note_217753671 we decided to have the documentation inside of the same repository as autoscaler so this repository. The documentation will be hosted on GitLab pages (most likely Hugo since we are most familiar with Go). Then inside of the GitLab official documentation for example https://docs.gitlab.com/runner/executors/custom_examples/index.html we will link to this GitLab pages.
Things to document
- The runner manager needs to be in the same internal network since we are using the internal IP to communicate to the machine.