Skip to content

docs: update google-cloud-platform docs to use our marketplace image #9549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 6, 2023
Merged

docs: update google-cloud-platform docs to use our marketplace image #9549

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2626126
Update google-cloud-platform.md
matifali Sep 6, 2023
4c01c9d
add gcp quick start
matifali Sep 6, 2023
2c76f0c
make fmt
matifali Sep 6, 2023
76d147f
update restart instructions
matifali Sep 6, 2023
1f9d495
update image
matifali Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
make fmt
  • Loading branch information
@matifali
matifali committed Sep 6, 2023
commit 2c76f0ceca7df2824752b6e474f332644e2879f9
38 changes: 29 additions & 9 deletions docs/platforms/google-cloud-platform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,46 @@ 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. Search for `Coder-v2` in the GCP Marketplace or [use direct link](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2).
We publish an Ubuntu 22.04 VM image with Coder and Docker pre-installed. Search
for `Coder-v2` in the GCP Marketplace or
[use direct link](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2).

![Coder on GCP Marketplace](../images/platforms/gcp/marketplace.png)

Be sure to keep the default firewall options checked so you can connect over HTTP, HTTPS, and SSH.
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/scale.md)
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/scale.md)

<video autoplay playsinline loop>
<source src="https://github.com/coder/coder/blob/main/docs/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/configure.md).
Be sure to add a keypair so that you can connect over SSH to further
[configure Coder](../admin/configure.md).

After launching the instance, wait 30 seconds and navigate to the public IPv4 address. You should be redirected to a public tunnel URL.
After launching the instance, wait 30 seconds and navigate to the public IPv4
address. You should be redirected to a public tunnel URL.

![Coder on GCP Marketplace start](../images/platforms/gcp/start.png)

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.
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.

![Coder Workspace and IDE in GCP VM](../images/platforms/gcp/workspace.png)

## 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/configure.md) by logging in via SSH or using the console:
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/configure.md) by logging in via SSH
or using the console:

```shell
ssh ubuntu@<gcp-public-IPv4>
Expand All @@ -45,9 +59,15 @@ sudo service coder restart # 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](https://github.com/coder/coder/tree/main/examples/templates/gcp-linux) template.
Instead of running containers on the Coder instance, you can offer developers
full VM instances with the
[gcp-linux](https://github.com/coder/coder/tree/main/examples/templates/gcp-linux)
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](https://github.com/coder/coder/tree/main/examples/templates/gcp-linux#authentication) to set up authentication.
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](https://github.com/coder/coder/tree/main/examples/templates/gcp-linux#authentication)
to set up authentication.

## Next Steps

Expand Down