|
| 1 | +# Google Cloud Platform |
| 2 | + |
| 3 | +In this guide, you will learn how to deploy the Coder control plane instance and |
| 4 | +your first template. |
| 5 | + |
| 6 | +## Requirements |
| 7 | + |
| 8 | +This guide assumes you have `roles/compute.instanceAdmin.v1` access to your |
| 9 | +Google Cloud Platform project. |
| 10 | + |
| 11 | +## Launch a Coder instance from the Google Cloud Marketplace |
| 12 | + |
| 13 | +We publish an Ubuntu 22.04 VM image with Coder and Docker pre-installed. Search |
| 14 | +for `Coder v2` in the GCP Marketplace or |
| 15 | +[use direct link](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2). |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +Be sure to keep the default firewall options checked so you can connect over |
| 20 | +HTTP, HTTPS, and SSH. |
| 21 | + |
| 22 | +We recommend keeping the default instance type (`e2-standard-4`, 4 cores and 16 |
| 23 | +GB memory) if you plan on provisioning Docker containers as workspaces on this |
| 24 | +VM instance. Keep in mind this platforms is intended for proof-of-concept |
| 25 | +deployments and you should adjust your infrastructure when preparing for |
| 26 | +production use. See: [Scaling Coder](../admin/scale.md) |
| 27 | + |
| 28 | +<video autoplay playsinline loop> |
| 29 | + <source src="https://github.com/coder/coder/blob/main/docs/images/platforms/gcp/launch.mp4?raw=true" type="video/mp4"> |
| 30 | +Your browser does not support the video tag. |
| 31 | +</video> |
| 32 | + |
| 33 | +Be sure to add a keypair so that you can connect over SSH to further |
| 34 | +[configure Coder](../admin/configure.md). |
| 35 | + |
| 36 | +After launching the instance, wait 30 seconds and navigate to the public IPv4 |
| 37 | +address. You should be redirected to a public tunnel URL. |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | +That's all! Use the UI to create your first user, template, and workspace. We |
| 42 | +recommend starting with a Docker template since the instance has Docker |
| 43 | +pre-installed. |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +## Configuring Coder server |
| 48 | + |
| 49 | +Coder is primarily configured by server-side flags and environment variables. |
| 50 | +Given you created or added key-pairs when launching the instance, you can |
| 51 | +[configure your Coder deployment](../admin/configure.md) by logging in via SSH |
| 52 | +or using the console: |
| 53 | + |
| 54 | +```shell |
| 55 | +ssh ubuntu@<gcp-public-IPv4> |
| 56 | +sudo vim /etc/coder.d/coder.env # edit config |
| 57 | +sudo systemctl daemon-reload |
| 58 | +sudo systemctl restart coder # restart Coder |
| 59 | +``` |
| 60 | + |
| 61 | +## Give developers VM workspaces (optional) |
| 62 | + |
| 63 | +Instead of running containers on the Coder instance, you can offer developers |
| 64 | +full VM instances with the |
| 65 | +[gcp-linux](https://github.com/coder/coder/tree/main/examples/templates/gcp-linux) |
| 66 | +template. |
| 67 | + |
| 68 | +Before you can use this template, you must authorize Coder to create VM |
| 69 | +instances in your GCP project. Follow the instructions in the |
| 70 | +[gcp-linux template README](https://github.com/coder/coder/tree/main/examples/templates/gcp-linux#authentication) |
| 71 | +to set up authentication. |
| 72 | + |
| 73 | +## Next Steps |
| 74 | + |
| 75 | +- [IDEs with Coder](../ides.md) |
| 76 | +- [Writing custom templates for Coder](../templates/index.md) |
| 77 | +- [Configure the Coder server](../admin/configure.md) |
| 78 | +- [Use your own domain + TLS](../admin/configure.md#tls--reverse-proxy) |
0 commit comments