Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

add Coder hosted getting started guide #571

Merged
merged 11 commits into from
Sep 3, 2021
Merged

add Coder hosted getting started guide #571

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6483ded
add Coder hosted getting started guide
ericpaulsen Aug 30, 2021
d782776
add CTA & access note
ericpaulsen Aug 30, 2021
bcaf481
update with Mike's feedback
ericpaulsen Aug 30, 2021
cbce660
Edit text
Aug 31, 2021
61d629b
Modify name, update URL
Aug 31, 2021
936b5e4
Update final instructions
Sep 3, 2021
aea01d1
add Coder hosted getting started guide
ericpaulsen Aug 30, 2021
554714b
add CTA & access note
ericpaulsen Aug 30, 2021
28ec98c
update with Mike's feedback
ericpaulsen Aug 30, 2021
0e534cf
Edit text
Aug 31, 2021
1546f7f
Modify name, update URL
Aug 31, 2021
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
Next Next commit
add Coder hosted getting started guide
  • Loading branch information
@ericpaulsen
ericpaulsen authored and Katie Horne committed Sep 3, 2021
commit 6483ded31e08efe51199cf41f55a2b00b22c1a37
57 changes: 57 additions & 0 deletions guides/saas/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Getting started with Coder's hosted beta
description: Get started with a hosted Coder deployment.
---

To help you get started, we've put together this guide to help you understand
how the Coder hosted beta works and how to access your deployment.

## What is Coder hosted beta?
Copy link
Member

@bpmct bpmct Aug 30, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CoderErik created a lovely graphic demonstrating how this works. thoughts on adding a version of this in a later revision?

We also discussed modifying this graphic OR adding a second graphic to demonstrate that the clients actually have a point-to-point connection with workspaces. Thoughts on that as well?

@jmilling33 could probably work his magic on it

Shared Hosting.pdf

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops here is the updated graphic

Shared Hosting (1).pdf

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely think @CoderErik's graphic would fit well in here.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a link to png version
https://lucid.app/publicSegments/view/7e950228-6b5a-47eb-b9d4-ed5a82e5898d/image.png

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmilling33 from a design standpoint, should we defer to you on that? @CoderErik's graphic is accurate, but I just want to make sure we keeps things consistent.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am happy to restyle the graphic to make sure it's consistent with our branding. When do you need it by?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmilling33 Just shared the original file with you. Check email for the link.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmilling33 no hard deadline. It would be nice to update this doc in ~1 week or so via another PR.

For now, we can leave the illustration out


The Coder hosted beta is a hybrid cloud offering of Coder's self-hosted
platform. With this model, Coder hosts the control plane, and you host your
compute and development workspaces. The benefits include:

- Automatic upgrades
- No installation or DNS configuration
- Managed logging & monitoring

Curious how this works? Here's a breakdown of the architecture:

**Coder's infrastructure**:

- The `coderd` service - Responsible for rendering the dashboard UI,
provisioning workspaces and user authentication, including a variety of other functions
- Your `coderd` instance is _not_ shared across other Coder accounts. Each deployment
receives their own `coderd` instance
- A PostgreSQL DB - Stores metadata related to your Coder instance,
such as user information, session tokens, etc.
- Coder uses a single PostgreSQL instance with each deployment having their
own database within the instance

**Your infrastructure**:

- Kubernetes cluster - Hosts your Coder workspaces, in addition to your source
code, which is stored on [Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
that are mounted to each workspace pod

`coderd` connects to your infrastructure through a service account created in
your cluster, enabling you to create workspaces in your cluster.

## Accessing your Coder hosted beta

1. Navigate to your deployment URL and login with the provided credentials:

- Deployment URL should be `<your-name>.coder.com`

- Username should be `admin`

- Password should be similar to `Lv7...k3`

1. Once logged in, you'll be prompted to change your temporary password

1. Enter the license file provided to you by email

You're in! Now that you've successfully accessed your hosted Coder deployment,
it's time to connect your Kubernetes cluster to Coder. See our guide on creating
a workspace provider (insert link here).