mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Nick Vigilante
14a61041d9
Fix four broken links that caused the weekly-docs link-check CI job to fail. **Changes:** - `docs/install/rancher.md`: Remove `#readme` anchor from `../../helm#readme` — linkspector splits on `#`, finds a directory, and errors with EISDIR. - `docs/install/kubernetes.md`: Same fix for `../../helm/coder#readme`. - `docs/install/cloud/compute-engine.md`: Point both `gcp-linux` links to `README.md` explicitly (`../../../examples/templates/gcp-linux/README.md` and `../../../examples/templates/gcp-linux/README.md#authentication`) so linkspector can resolve the file and anchor. - `.github/.linkspector.yml`: Add `merriam-webster.com` to `ignorePatterns` (returns 403 from GitHub runner IPs). <details> <summary>Linear issue and CI context</summary> **Linear issue:** https://linear.app/codercom/issue/DOCS-494/fix-broken-links-in-weekly-docs-link-check **Failing CI run:** https://github.com/coder/coder/actions/runs/28366176335/job/84032582533 The workflow is `.github/workflows/weekly-docs.yaml`, job `check-docs`, step `Check Markdown links` (umbrelladocs/action-linkspector). Root causes confirmed per investigation: - `#readme` anchors on directory paths trigger EISDIR in linkspector's local resolver. - The `gcp-linux` directory links needed explicit `README.md` targets; linkspector cannot resolve bare directory references. - `merriam-webster.com` blocks GitHub runner IPs with 403. `ignorePatterns` is reserved for external links only, not internal or GitHub file links. </details> --- *Generated by Coder Agents on behalf of @nickvigilante*
82 lines
3.3 KiB
Markdown
82 lines
3.3 KiB
Markdown
# Google Cloud Platform
|
|
|
|
In this guide, you will learn how to deploy the Coder control plane instance and
|
|
your first template.
|
|
|
|
## Requirements
|
|
|
|
This guide assumes you have `roles/compute.instanceAdmin.v1` access to your
|
|
Google Cloud Platform project.
|
|
|
|
## Launch a Coder instance from the Google Cloud Marketplace
|
|
|
|
We publish an Ubuntu 22.04 VM image with Coder and Docker pre-installed.
|
|
|
|
Two SKU's are available via the Google Cloud Marketplace:
|
|
|
|
1. [License purchase via Google Cloud Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-gcmp?inv=1&invt=Ab45rg&project=secret-beacon-468405-p5)
|
|
2. [A solution to deploy VM's on GCP (Bring Your Own License)](https://console.cloud.google.com/marketplace/product/workspan-public-422119/coder?inv=1&invt=Ab45rg&project=secret-beacon-468405-p5)
|
|
|
|
|
|
|
|
Be sure to keep the default firewall options checked so you can connect over
|
|
HTTP, HTTPS, and SSH.
|
|
|
|
We recommend keeping the default instance type (`e2-standard-4`, 4 cores and 16
|
|
GB memory) if you plan on provisioning Docker containers as workspaces on this
|
|
VM instance. Keep in mind this platforms is intended for proof-of-concept
|
|
deployments and you should adjust your infrastructure when preparing for
|
|
production use. See: [Scaling Coder](../../admin/infrastructure/index.md)
|
|
|
|
<video autoplay playsinline loop>
|
|
<source src="../../images/platforms/gcp/launch.mp4?raw=true" type="video/mp4">
|
|
Your browser does not support the video tag.
|
|
</video>
|
|
|
|
Be sure to add a keypair so that you can connect over SSH to further
|
|
[configure Coder](../../admin/setup/index.md).
|
|
|
|
After launching the instance, wait 30 seconds and navigate to the public IPv4
|
|
address. You should be redirected to a public tunnel URL.
|
|
|
|
|
|
|
|
That's all! Use the UI to create your first user, template, and workspace. We
|
|
recommend starting with a Docker template since the instance has Docker
|
|
pre-installed.
|
|
|
|
|
|
|
|
## Configuring Coder server
|
|
|
|
Coder is primarily configured by server-side flags and environment variables.
|
|
Given you created or added key-pairs when launching the instance, you can
|
|
[configure your Coder deployment](../../admin/setup/index.md) by logging in via
|
|
SSH or using the console:
|
|
|
|
```shell
|
|
ssh ubuntu@<gcp-public-IPv4>
|
|
sudo vim /etc/coder.d/coder.env # edit config
|
|
sudo systemctl daemon-reload
|
|
sudo systemctl restart coder # restart Coder
|
|
```
|
|
|
|
## Give developers VM workspaces (optional)
|
|
|
|
Instead of running containers on the Coder instance, you can offer developers
|
|
full VM instances with the
|
|
[gcp-linux](../../../examples/templates/gcp-linux/README.md)
|
|
template.
|
|
|
|
Before you can use this template, you must authorize Coder to create VM
|
|
instances in your GCP project. Follow the instructions in the
|
|
[gcp-linux template README](../../../examples/templates/gcp-linux/README.md#authentication)
|
|
to set up authentication.
|
|
|
|
### Next Steps
|
|
|
|
- [Use your IDE with Coder](../../user-guides/workspace-access/index.md)
|
|
- [Writing custom templates for Coder](../../admin/templates/index.md)
|
|
- [Configure the Coder server](../../admin/setup/index.md)
|
|
- [Use your own domain + TLS](../../admin/setup/index.md#tls--reverse-proxy)
|