Files
threshold/website/content/docs/getting-started/dev-mode/dev-mode.mdx
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

66 lines
3.1 KiB
Plaintext
Raw Normal View History

2022-06-22 00:37:49 -06:00
---
layout: docs
page_title: What is dev mode?
2023-08-16 13:47:23 -04:00
description: Getting started with Boundary Community Edition in dev mode
2022-06-22 00:37:49 -06:00
---
# What is dev mode?
2022-06-22 00:37:49 -06:00
Dev mode is a method for getting started with Boundary quickly for testing and
learning purposes. As the name implies, dev mode is not a production
installation method, and provides a way to get Boundary running with a Postgres
database easily. Do not use dev mode in a production environment, see the
2023-01-20 18:17:34 -05:00
[Production Installation](/boundary/docs/oss/installing/high-availability) section for
2022-06-22 00:37:49 -06:00
production-ready deployment methods.
Dev mode brings up a fully-functioning instance of Boundary, including:
- A controller server
- A worker server
- A Postgres database
These components should all be considered ephemeral - no data persistence occurs
across dev mode restarts. Along with these external components, dev mode also
creates several resources within Boundary to make it easier and faster to
connect to your first target:
2023-01-20 18:17:34 -05:00
1. An org [scope](/boundary/docs/concepts/domain-model/scopes) and a project scope with a
2022-06-22 00:37:49 -06:00
default ID of `o_1234567890` and `p_1234567890` respectively.
2023-01-20 18:17:34 -05:00
1. A password [auth method](/boundary/docs/concepts/domain-model/auth-methods) with a
2022-06-22 00:37:49 -06:00
default auth method ID of `ampw_1234567890`.
2023-01-20 18:17:34 -05:00
1. An OIDC [auth method](/boundary/docs/concepts/domain-model/auth-methods) with a
2022-06-22 00:37:49 -06:00
default auth method ID of `amoidc_1234567890`.
1. An admin user with login name `admin` and password `password`.
1. An unprivileged user with login name `user` and password `password`.
2023-01-20 18:17:34 -05:00
1. A static [host catalog](/boundary/docs/concepts/domain-model/host-catalogs) with a
2022-06-22 00:37:49 -06:00
default ID of `hcst_1234567890`.
2023-01-20 18:17:34 -05:00
1. A static [host](/boundary/docs/concepts/domain-model/hosts) and [host
set](/boundary/docs/concepts/domain-model/host-sets) with default ID's of
2022-06-22 00:37:49 -06:00
`hst_1234567890` and `hsst_1234567890` respectively.
2023-01-20 18:17:34 -05:00
1. A TCP [target](/boundary/docs/concepts/domain-model/targets) with a default ID of
`ttcp_1234567890`, directly set-up with an address and port.
2023-01-20 18:17:34 -05:00
1. A TCP [target](/boundary/docs/concepts/domain-model/targets) with a default ID of
`ttcp_0987654321` using the previously mentioned static host set.
2022-06-22 00:37:49 -06:00
The default ID suffixes can be overwritten or randomly generated, and there are
many other dev mode controls. To see a complete list of these override flags,
consult `boundary dev -h`.
If you plan on provisioning a large number of resources in dev mode, it's
strongly recommended that users leverage our [Terraform Provider for
Boundary](https://github.com/hashicorp/terraform-provider-boundary) for managing
configuration of Boundary. This will simplify starting up and shutting down your
Boundary dev instance.
## Requirements
There are a few requirements for running dev mode:
- [Docker](https://docs.docker.com/get-docker/) is installed
- A route to download the [Postgres Docker
image](https://hub.docker.com/_/postgres) is available or a local image cache
is available
2023-01-20 18:17:34 -05:00
- A [Boundary binary](/boundary/downloads) in your `$PATH`
2022-06-22 00:37:49 -06:00
- _Optionally_, an [installation of Boundary
2023-01-20 18:17:34 -05:00
Desktop](/boundary/tutorials/oss-getting-started/oss-getting-started-desktop-app)
2022-06-22 00:37:49 -06:00
if you want to use the desktop examples