rancher
/
windows
mirror of https://github.com/rancher/windows.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
windows/docs/terraform/development.md

2.7 KiB
Raw Permalink Blame History

Setting up a Rancher development environment

To set up an environment to develop on Rancher Windows repositories, you can take the following steps.

Initial Setup

Initialize all the Terraform modules used in this guide:

terraform -chdir=terraform/azure_server init

Note: Windows requires an RSA-based SSH key pair.

Connecting to Azure

The Terraform modules used in this guide assume that the user has already authenticated their current machine to Azure by following the guidance of the Azure Terraform Provider.

Using VSCode Remote Explorer (optional)

For developers who use VSCode, it may be useful to install the Remote Explorer extension, which makes it far easier to launch terminals or view files on a remote machine.

Provision a Windows development server

To provision a Windows development server in Azure, run the following Terraform command at the root of this repository to create an Windows server with Rancher Developer Tools installed:

TF_NAME_PREFIX="clippy-test"

terraform -chdir=terraform/azure_server apply -var="name=${TF_NAME_PREFIX}-server" -var-file="examples/windows_dev.tfvars"

Setting up repositories

Once all initialization scripts have finished running, your Windows host should have the following tools installed:

  1. chocolatey (choco)
  2. git
  3. go
  4. kubernetes-cli (kubectl)
  5. docker
  6. containerd
  7. WSL (Ubuntu 1804)

Note: To enable WSL, you may have to run the following command manually while logged in as adminuser:

& C:\Windows\System32\wsl\ubuntu1804.exe install --root

After running this command, you should be able to run bash to hop into the WSL terminal.

It also adds two PowerShell functions to your profile:

  1. Clone-Repo <repository>: this function takes in a repository like rancher/windows and clones it to the path C:\go\src\github.com\<repository> directory on your host.
  2. Go-Repo <repository>: given a repository in the same format as Clone-Repo expects (i.e. rancher/windows), this changes your current working directory to C:\go\src\github.com\<repository>

To install all the basic windows Repositories on your host, run the following command:

Clone-Repo rancher/wins
Clone-Repo rancher/windows
Clone-Repo rancher/Rancher-Plugin-gMSA