diff --git a/README (1).md b/README (1).md index 7cb21e6..cdc8abf 100644 --- a/README (1).md +++ b/README (1).md @@ -1,7 +1,6 @@ --- title: Platform Overview --- -# Platform Overview ## What is DevZero? diff --git a/README.md b/README.md index 26edbcd..c6d56ab 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,8 @@ layout: ## Welcome to DevZero -{% hint style="info" %} -**New to the platform?**\ -\ -We recommend getting started with our [readme-1.md](getting-started/readme-1.md "mention") and then running through the [quickstart.md](getting-started/quickstart.md "mention") example. -{% endhint %} +> **New to the platform?** +> We recommend getting started with our [readme-1.md](getting-started/readme-1.md "mention") and then running through the [quickstart.md](getting-started/quickstart.md "mention") example. *** diff --git a/STYLE.md b/STYLE.md index d5b3a3f..5e0a897 100644 --- a/STYLE.md +++ b/STYLE.md @@ -1,7 +1,6 @@ --- title: DevZero docs style guide --- -# DevZero docs style guide 1. Images should have descriptive alt description diff --git a/SUMMARY.md b/SUMMARY.md index 8d41cd3..9580249 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,7 +1,6 @@ --- title: Table of contents --- -# Table of contents ## ℹ️ Getting Started diff --git a/admin/acls.md b/admin/acls.md index f3d1efd..bdd1e8b 100644 --- a/admin/acls.md +++ b/admin/acls.md @@ -1,8 +1,5 @@ --- title: ACLs --- -# ACLs -{% hint style="info" %} -**Coming soon...** We currently support a handful of predefined user roles and permission sets. Additional customization options are expected to land later this year. -{% endhint %} +> **Coming soon...** We currently support a handful of predefined user roles and permission sets. Additional customization options are expected to land later this year. diff --git a/admin/hosting.md b/admin/hosting.md index dfe78ac..e08a59c 100644 --- a/admin/hosting.md +++ b/admin/hosting.md @@ -1,7 +1,6 @@ --- title: Hosting --- -# Hosting ## Hosting Options diff --git a/admin/personal-access-tokens.md b/admin/personal-access-tokens.md index 281b81f..fd8e094 100644 --- a/admin/personal-access-tokens.md +++ b/admin/personal-access-tokens.md @@ -1,7 +1,6 @@ --- title: Personal Access Tokens --- -# Personal Access Tokens ## Managing Personal Access Tokens @@ -17,8 +16,6 @@ Deleting a token is performed in the same section. A personal access token can be used to authenticate the `dz` cli. Simply log in by passing the token contents via the `--token` flag. Upon token expiry, the cli will prompt to re-authenticate. -{% code lineNumbers="false" %} ``` dz auth login --token ``` -{% endcode %} diff --git a/admin/sso.md b/admin/sso.md index 8642649..d9ecf5a 100644 --- a/admin/sso.md +++ b/admin/sso.md @@ -1,7 +1,6 @@ --- title: Single Sign-on (SSO --- -# Single Sign-on (SSO Use-case: @@ -19,6 +18,4 @@ Many organizations use SSO to easily manage onboarding and offboarding of employ You can also create this as a [secret GitHub Gist](https://gist.github.com/) and send us a link! -{% hint style="info" %} -**Note...** We are aware that depending on the SSO provider you use, we might have to provide you a couple bits of information to put in your SSO Admin Portal. We will reach out to you if that's the case! -{% endhint %} +> **Note...** We are aware that depending on the SSO provider you use, we might have to provide you a couple bits of information to put in your SSO Admin Portal. We will reach out to you if that's the case! diff --git a/admin/user-management.md b/admin/user-management.md index 7882b9c..46b62b7 100644 --- a/admin/user-management.md +++ b/admin/user-management.md @@ -1,7 +1,6 @@ --- title: User Management --- -# User Management ## Inviting Teammates diff --git a/builds/builds/team.md b/builds/builds/team.md index 2fb4d18..44c5cf1 100644 --- a/builds/builds/team.md +++ b/builds/builds/team.md @@ -1,4 +1,3 @@ --- title: Team --- -# Team diff --git a/devzero-network/access-own-workspace.md b/devzero-network/access-own-workspace.md index fda41c1..71b89a1 100644 --- a/devzero-network/access-own-workspace.md +++ b/devzero-network/access-own-workspace.md @@ -1,7 +1,6 @@ --- title: Access Running Applications --- -# Access Running Applications ## Access Your Running Application(s) diff --git a/devzero-network/connecting.md b/devzero-network/connecting.md index 3631e4c..a10d94d 100644 --- a/devzero-network/connecting.md +++ b/devzero-network/connecting.md @@ -1,7 +1,6 @@ --- title: Adding Resources to your Network --- -# Adding Resources to your Network ## Add a peer to your DevZero network @@ -9,28 +8,22 @@ title: Adding Resources to your Network 2. [Install the CLI.](../references/cli-man-page/install-the-cli.md) 3. Run -{% code %} ``` sudo dz auth login ``` -{% endcode %} 4. Add the node to the network by running (_optional_ `--hostname` flag: replace `` with a memorable hostname) -{% code %} ``` sudo dz network connect --hostname= # example: sudo dz net connect --hostname=my-rds-jump-node ``` -{% endcode %} 5. Verify that the node is in the network by running -{% code %} ``` dz network status ``` -{% endcode %} ## Advertise routes to your DevZero network @@ -38,26 +31,20 @@ dz network status 2. Install the CLI following [these steps](./../references/cli-man-page/install-the-cli.md). 3. Run -{% code %} ``` sudo dz auth login ``` -{% endcode %} 4. Add the node to the network by running (_optional_ `--hostname` flag: replace `` with a memorable hostname) -{% code %} ``` sudo dz network connect --hostname= --advertise-routes= # example: sudo dz net connect --hostname=my-rds-jump-node --advertise-routes=172.31.0.0/16 # where the current node is on a VPC w/ CIDR range 172.31.0.0/16 ``` -{% endcode %} 5. Verify that the node is in the network by running -{% code %} ``` dz network status ``` -{% endcode %} diff --git a/devzero-network/overview.md b/devzero-network/overview.md index b11d9eb..776468b 100644 --- a/devzero-network/overview.md +++ b/devzero-network/overview.md @@ -1,7 +1,6 @@ --- title: Overview --- -# Overview The DevZero Network uses a decentralized VPN strategy to enable secure access to [nodes](../references/terminology.md#node) across your team. We accomplish thiusing WireGuard. diff --git a/devzero-network/status.md b/devzero-network/status.md index 4fad80e..b368da3 100644 --- a/devzero-network/status.md +++ b/devzero-network/status.md @@ -1,22 +1,19 @@ --- title: Network Status --- -# Network Status Currently, to see the peers that are present within your DevZero network, run -{% code %} + ``` dz network status ``` -{% endcode %}

dz network status

To view all the peers in your team, run -{% code %} + ``` dz network status --team ``` -{% endcode %}

dz network status --team

diff --git a/devzero-storage/overview.md b/devzero-storage/overview.md index 18a8f3d..0e40965 100644 --- a/devzero-storage/overview.md +++ b/devzero-storage/overview.md @@ -1,7 +1,6 @@ --- title: DevZero Storage --- -# DevZero Storage ## Volume diff --git a/devzero-storage/volume-elastic-nfs.md b/devzero-storage/volume-elastic-nfs.md index 8d0c61b..b8e5b3b 100644 --- a/devzero-storage/volume-elastic-nfs.md +++ b/devzero-storage/volume-elastic-nfs.md @@ -1,7 +1,6 @@ --- title: Volume (elastic NFS) --- -# Volume (elastic NFS) DevZero's volumes are multi-attach multi-read-write capable volumes (similar to AWS EFS). Volumes are regional in nature and can be attached to any workspace in that region. @@ -10,40 +9,33 @@ Volumes are regional in nature and can be attached to any workspace in that regi ### In your default region -{% code %} ``` $ dz storage volume create --name=my-fancy-volume --size=50 -ID Name Total size (GB) Region -7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA +ID Name Total size (GB) Region +7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA ``` -{% endcode %} ### In an arbitrary region -{% code %} ``` $ dz storage volume create --name=other-fancy-volume --size=50 --region=eu-north-1 -ID Name Total size (GB) Region -e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden +ID Name Total size (GB) Region +e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden ``` -{% endcode %} ## Listing your volumes -{% code %} ``` $ dz storage volume list -ID Name Total size (GB) Region -7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA -e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden +ID Name Total size (GB) Region +7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA +e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden ``` -{% endcode %} ## Launching a workspace with a volume The volume is mounted at the path specified by the `--mount` flag. -{% code %} ``` $ dz workspace launch "My Recipe Name" --region=us-west-2 --mount /mnt/my-shared-volume=7947b1c8-881c-49fb-b5c7-c3e0367a76f2 Your workspace is currently being built... please wait! @@ -52,7 +44,6 @@ Successfully deployed workspace dear-filly-ubhg To connect to this workspace, run: dz workspace connect dear-filly-ubhg -# OR $ dz workspace launch "My Recipe Name" --region=eu-north-1 --mount /mnt/my-shared-volume=e71e024e-ba0a-443a-b452-c931e8ce39a5 Your workspace is currently being built... please wait! @@ -61,11 +52,9 @@ Successfully deployed workspace abominal-monkey-ytui To connect to this workspace, run: dz workspace connect abominal-monkey-ytui ``` -{% endcode %} ### Verifying mounted volumes inside a workspace -{% code %} ``` $ dz workspace connect dear-filly-ubhg .... @@ -79,4 +68,3 @@ Filesystem K-blocks Used Available Use% Mounted on /dev/nvme6n1 51290592 16500 51257708 1% /home/devzero [some path..] 10485760 0 10485760 0% /mnt/my-shared-volume ``` -{% endcode %} diff --git a/environment-variables/env-vars.md b/environment-variables/env-vars.md index 3746739..e3d844a 100644 --- a/environment-variables/env-vars.md +++ b/environment-variables/env-vars.md @@ -1,7 +1,6 @@ --- title: Overview --- -# Overview Environment variables are materially public in nature. If you want to store or reference a secret value, see [Secrets](secrets.md). @@ -12,11 +11,8 @@ These are usually used by when: Once an environment variable is saved, it will be visible in the UI or CLI. It will be available at build- or launch-time. It will also be available in the running workspaces. -{% hint style="warning" %} -**Reserved prefix** `DEVZERO_` is a reserved prefix used by the platform. They may change at any time so relying on them is not advisable. - -You may store environment variables or secrets with line breaks. -{% endhint %} +> **Reserved prefix** `DEVZERO_` is a reserved prefix used by the platform. They may change at any time so relying on them is not advisable. +> You may store environment variables or secrets with line breaks. You can access environment variables within builds or at launch-time. If your variable is called `MY_KEY`, to access its value anywhere, use `$MY_KEY`. At runtime, you can use the `env` binary to verify that the secrets are present within that context. @@ -29,7 +25,7 @@ runtime: value: "{{secret:team.TEST_TEAM_ENV}}" - name: TEST_USER_ENV value: "{{secret:user.TEST_USER_ENV}}" - - name: FOO + - name: FOO value: "bar" ``` diff --git a/environment-variables/personal.md b/environment-variables/personal.md index b99cd0f..9909ede 100644 --- a/environment-variables/personal.md +++ b/environment-variables/personal.md @@ -1,15 +1,12 @@ --- title: User-scoped --- -# User-scoped ## Saving an user-scoped environment variable Visit the Environment Variables section at [https://www.devzero.io/dashboard/environment-variables/user](https://www.devzero.io/dashboard/environment-variables/user) to add, remove, or update your user-scoped environment variables and secrets. User-scoped environment variables can only be seen, managed, and used by you. -{% hint style="info" %} -User-scoped environment variables are automatically made available on each of your running workspaces by default. -{% endhint %} +> User-scoped environment variables are automatically made available on each of your running workspaces by default.

Adding personal environment variables

@@ -19,9 +16,7 @@ User-scoped environment variables are automatically made available on each of yo Using an environment variable within your workspace is how you would normally use any environment variable (eg: `echo $NOT_SO_SECRET_KEY`). -{% hint style="info" %} -Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace. -{% endhint %} +> Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace. To use it in a recipe, you can reference it the same way. If your environment variable is called `MY_KEY`: diff --git a/environment-variables/secrets.md b/environment-variables/secrets.md index bef2d96..1d51755 100644 --- a/environment-variables/secrets.md +++ b/environment-variables/secrets.md @@ -1,21 +1,16 @@ --- title: Secrets --- -# Secrets Secrets are used to store and reference secret values. -{% hint style="info" %} -To store a secret, navigate to the environment variables page and add a new key-value pair. Before saving, be sure to check "Secret". This stores the environment variable as a secret with the additional protections described below. -{% endhint %} +> To store a secret, navigate to the environment variables page and add a new key-value pair. Before saving, be sure to check "Secret". This stores the environment variable as a secret with the additional protections described below.
Once a secret is saved, its value cannot be viewed or modified. You can only replace or delete the value. Otherwise, secrets work just like other environment variables. -{% hint style="info" %} -Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace. -{% endhint %} +> Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace. You can access secrets within builds or at build or launch time, just like you would access any environment variable. If your secret is called `MY_SECRET_KEY`, to access its value anywhere, use `$MY_SECRET_KEY`. At runtime, you can use the `env` binary to verify that the secrets are present within that context. diff --git a/environment-variables/team.md b/environment-variables/team.md index f50952c..a2e531f 100644 --- a/environment-variables/team.md +++ b/environment-variables/team.md @@ -1,7 +1,6 @@ --- title: Team-scoped --- -# Team-scoped ## Saving a team-scoped environment variable @@ -9,9 +8,7 @@ Visit the Environment Variables section at [https://www.devzero.io/dashboard/env

Team environment variables

-{% hint style="info" %} -Team-scoped environment variables and secrets must be directly referenced in your recipe template steps. Unlike user-scoped environment variables, they are **not** automatically added to every workspace. -{% endhint %} +> Team-scoped environment variables and secrets must be directly referenced in your recipe template steps. Unlike user-scoped environment variables, they are **not** automatically added to every workspace.

Team Environment Variables

diff --git a/getting-started/quickstart.md b/getting-started/quickstart.md index 41cf218..7e0822b 100644 --- a/getting-started/quickstart.md +++ b/getting-started/quickstart.md @@ -3,13 +3,12 @@ description: 'Estimated time to complete: ~5 mins' title: Quickstart --- -# Quickstart **Welcome!** :wave: Follow the steps below to get started on the DevZero platform. Or, if you're more of a visual learner, we have a video tutorial as well! -{% embed url="https://devzero.b-cdn.net/Onboarding%20v2.mp4" %} +[![Onboarding Video](https://devzero.b-cdn.net/Onboarding%20v2.mp4)](https://devzero.b-cdn.net/Onboarding%20v2.mp4) ## Step 1. Signing up for an account @@ -27,9 +26,7 @@ We currently only offer native support for GitHub as a code provider for DevZero If you only plan to work with public repositories, you do not need to enable our GitHub integration. However, if you'd like to work with private codebases, you'll need to head to [https://www.devzero.io/dashboard/settings/user-settings](https://www.devzero.io/dashboard/settings/user-settings) and complete the installation and authorization steps. -{% hint style="info" %} -For more information (including a hack to use Bitbucket and GitLab repos), see our [Source Code in Recipes](./../recipes/cloning-source-code.md) guide. -{% endhint %} +> For more information (including a hack to use Bitbucket and GitLab repos), see our [Source Code in Recipes](./../recipes/cloning-source-code.md) guide. ## Step 3. Creating Your First Recipe @@ -108,13 +105,10 @@ To install in WSL 2 (**does not** work on WSL 1):
-{% hint style="info" %} -**Please be sure to run these two commands after the installer finishes:** - -``` -sudo dz auth login && sudo dz net connect -``` -{% endhint %} +> **Please be sure to run these two commands after the installer finishes:** +> ``` +> sudo dz auth login && sudo dz net connect +> ``` ## Step 6. Connecting to your Workspace diff --git a/getting-started/readme-1.md b/getting-started/readme-1.md index bb1454f..12fa3df 100644 --- a/getting-started/readme-1.md +++ b/getting-started/readme-1.md @@ -1,7 +1,6 @@ --- title: Platform Overview --- -# Platform Overview ## What is DevZero? diff --git a/how-to-guides/build-cache/README.md b/how-to-guides/build-cache/README.md index 63235ee..8fa43bb 100644 --- a/how-to-guides/build-cache/README.md +++ b/how-to-guides/build-cache/README.md @@ -1,6 +1,5 @@ --- title: Build Cache + Remote Execution --- -# Build Cache + Remote Execution
Bazelbazel.pngbazel-remote-execution-cache.md
Dockerdocker.pngdocker-remote-build-cache.md
diff --git a/how-to-guides/build-cache/bazel-remote-execution-cache.md b/how-to-guides/build-cache/bazel-remote-execution-cache.md index 3a28f41..5b426e2 100644 --- a/how-to-guides/build-cache/bazel-remote-execution-cache.md +++ b/how-to-guides/build-cache/bazel-remote-execution-cache.md @@ -1,11 +1,8 @@ --- title: Bazel --- -# Bazel -{% hint style="info" %} -Looking for a pre-made recipe template? See: [Bazel Buildfarm](../../references/starter-templates/ci-cd/bazel-buildfarm.md) -{% endhint %} +> Looking for a pre-made recipe template? See: [Bazel Buildfarm](../../references/starter-templates/ci-cd/bazel-buildfarm.md) ## Installation (using Helm) diff --git a/how-to-guides/build-cache/docker-remote-build-cache.md b/how-to-guides/build-cache/docker-remote-build-cache.md index 33a2fd6..c245ca6 100644 --- a/how-to-guides/build-cache/docker-remote-build-cache.md +++ b/how-to-guides/build-cache/docker-remote-build-cache.md @@ -1,7 +1,6 @@ --- title: Docker --- -# Docker ## Remote build/cache using `DOCKER_HOST` @@ -26,9 +25,7 @@ docker info When you run the `docker build` command, the build context will be sent to the DevBox and the build process will run. -{% hint style="info" %} -If you're seeing "Host key verification failed" error, try connecting to your DevBox via ssh first to verify the fingerprint. -{% endhint %} +> If you're seeing "Host key verification failed" error, try connecting to your DevBox via ssh first to verify the fingerprint. ## Remote build using BuildKit @@ -98,10 +95,7 @@ docker buildx build --push -t your-devbox-hostname:5000/ \ curl http://your-devbox-hostname:5000/v2/_catalog ``` -{% hint style="info" %} -If you're getting "http: server gave HTTP response to HTTPS client", try adding the following to your Docker daemon json configuration: - -``` -insecure-registries": ["your-devbox-hostname:5000"] -``` -{% endhint %} +> If you're getting "http: server gave HTTP response to HTTPS client", try adding the following to your Docker daemon json configuration: +> ``` +> "insecure-registries": ["your-devbox-hostname:5000"] +> ``` diff --git a/how-to-guides/ci/README.md b/how-to-guides/ci/README.md index 1965ab4..9116342 100644 --- a/how-to-guides/ci/README.md +++ b/how-to-guides/ci/README.md @@ -1,6 +1,5 @@ --- title: CI --- -# CI
GitHub Actionsgithub.pngrun-github-actions-in-a-devbox.md
diff --git a/how-to-guides/ci/run-github-actions-in-a-devbox.md b/how-to-guides/ci/run-github-actions-in-a-devbox.md index 90f394a..852c429 100644 --- a/how-to-guides/ci/run-github-actions-in-a-devbox.md +++ b/how-to-guides/ci/run-github-actions-in-a-devbox.md @@ -5,11 +5,8 @@ description: >- title: GitHub Actions --- -# GitHub Actions -{% hint style="info" %} -Pre-built recipe templates are available [here](../../references/starter-templates/ci-cd/github-actions.md). -{% endhint %} +> Pre-built recipe templates are available [here](../../references/starter-templates/ci-cd/github-actions.md). ## Using a self-hosted runner @@ -51,20 +48,17 @@ export TOKEN_FROM_GITHUB="" # insert token # for a specific repo # ./config.sh --url https://github.com/ORGANIZATION/REPO --token $TOKEN_FROM_GITHUB ``` -{% hint style="info" %} -The token from GitHub wll expire in about an hour and is unique for your instance. -You can also get the registration token non-interactively by sending a http request using curl: - -``` -curl \ - -X POST \ - -H "Accept: application/vnd.github+json" \ - -H "Authorization: Bearer "${{ GITHUB_PAT }}"" \ - https://api.github.com/repos/ORGANIZATION/REPO/actions/runners/registration-token -``` - -{% endhint %} +> The token from GitHub wll expire in about an hour and is unique for your instance. +> You can also get the registration token non-interactively by sending a http request using curl: +> +> ``` +> curl \ +> -X POST \ +> -H "Accept: application/vnd.github+json" \ +> -H "Authorization: Bearer "${{ GITHUB_PAT }}"" \ +> https://api.github.com/repos/ORGANIZATION/REPO/actions/runners/registration-token +> ``` ### Install and Start @@ -75,9 +69,7 @@ sudo ./svc.sh install root && sudo ./svc.sh start 7. Verify that the runner was added to your repo/org and is either in "Idle" or "Online" state. -{% hint style="info" %} -Tip: The runner name should be same as the DevBox hostname. -{% endhint %} +> Tip: The runner name should be same as the DevBox hostname. 8. Run a GitHub Action on the self-hosted runner to verify that it passes successfully, set `runs-on: self-hosted`: @@ -96,13 +88,11 @@ jobs: Here's a five minute video to see the process from end to end. -{% embed url="https://devzero.b-cdn.net/Setting%20up%20Self-Hosted%20GitHub%20Actions%20on%20DevZero%20%F0%9F%9B%A0%EF%B8%8F.mp4" %} +[![Setting up Self-Hosted GitHub Actions on DevZero](https://devzero.b-cdn.net/Setting%20up%20Self-Hosted%20GitHub%20Actions%20on%20DevZero%20%F0%9F%9B%A0%EF%B8%8F.mp4)](https://devzero.b-cdn.net/Setting%20up%20Self-Hosted%20GitHub%20Actions%20on%20DevZero%20%F0%9F%9B%A0%EF%B8%8F.mp4) ## Using Actions Runner Controller -{% hint style="warning" %} -The Actions Runner Controller setup is still in beta and some actions, like running Docker in tests, aren't yet supported. -{% endhint %} +> The Actions Runner Controller setup is still in beta and some actions, like running Docker in tests, aren't yet supported. You will need a Personal Access Token (PAT). @@ -120,9 +110,7 @@ After you obtained the PAT: ### Scale-set controller -{% hint style="info" %} -Adjust the `NAMESPACE`variable as needed. -{% endhint %} +> Adjust the `NAMESPACE`variable as needed.
NAMESPACE=dz-arc-systems
 helm install arc \
@@ -133,9 +121,7 @@ helm install arc \
 
 ### Runner scale-set
 
-{% hint style="info" %}
-Adjust the `INSTALLATION_NAME`, `NAMESPACE`, `GITHUB_CONFIG_URL`, and `GITHUB_PAT` variables as needed.
-{% endhint %}
+> Adjust the `INSTALLATION_NAME`, `NAMESPACE`, `GITHUB_CONFIG_URL`, and `GITHUB_PAT` variables as needed.
 
 ```
 helm install "${INSTALLATION_NAME}" \
diff --git a/how-to-guides/cloud-services/README.md b/how-to-guides/cloud-services/README.md
index 5d92936..c81580a 100644
--- a/how-to-guides/cloud-services/README.md
+++ b/how-to-guides/cloud-services/README.md
@@ -1,7 +1,6 @@
 ---
 title: Cloud Services
 ---
-# Cloud Services
 
 
diff --git a/how-to-guides/cloud-services/aws/README.md b/how-to-guides/cloud-services/aws/README.md
index f550ab9..f1aa301 100644
--- a/how-to-guides/cloud-services/aws/README.md
+++ b/how-to-guides/cloud-services/aws/README.md
@@ -1,7 +1,6 @@
 ---
 title: AWS
 ---
-# AWS
 
 
diff --git a/how-to-guides/cloud-services/aws/connect-to-a-documentdb-cluster.md b/how-to-guides/cloud-services/aws/connect-to-a-documentdb-cluster.md index 6322c47..646f859 100644 --- a/how-to-guides/cloud-services/aws/connect-to-a-documentdb-cluster.md +++ b/how-to-guides/cloud-services/aws/connect-to-a-documentdb-cluster.md @@ -1,7 +1,6 @@ --- title: DocumentDB --- -# DocumentDB Connecting to DocumentDB running in the private subnet of AWS VPC from your DevBox. diff --git a/how-to-guides/cloud-services/aws/connect-to-an-ec2-instance.md b/how-to-guides/cloud-services/aws/connect-to-an-ec2-instance.md index db388ba..663df56 100755 --- a/how-to-guides/cloud-services/aws/connect-to-an-ec2-instance.md +++ b/how-to-guides/cloud-services/aws/connect-to-an-ec2-instance.md @@ -1,13 +1,12 @@ ---- -title: EC2 ---- -# EC2 +--- +title: EC2 +--- Connecting to EC2 running in the private subnet of AWS VPC from your DevBox. ## Walkthrough video -{% embed url="https://devzero.b-cdn.net/Connect%20AWS%20EC2%20Instances%20to%20Your%20Dev%20Box-inline-subtitles.mp4" %} +[![Connect AWS EC2 Instances to Your Dev Box](https://devzero.b-cdn.net/Connect%20AWS%20EC2%20Instances%20to%20Your%20Dev%20Box-inline-subtitles.mp4)](https://devzero.b-cdn.net/Connect%20AWS%20EC2%20Instances%20to%20Your%20Dev%20Box-inline-subtitles.mp4) ## Architecture Diagram diff --git a/how-to-guides/cloud-services/aws/connect-to-an-eks-cluster.md b/how-to-guides/cloud-services/aws/connect-to-an-eks-cluster.md index 39d6bc8..17777f5 100644 --- a/how-to-guides/cloud-services/aws/connect-to-an-eks-cluster.md +++ b/how-to-guides/cloud-services/aws/connect-to-an-eks-cluster.md @@ -1,7 +1,6 @@ --- title: EKS --- -# EKS Connecting to EKS running in the private subnet of AWS VPC from your DevBox. @@ -20,35 +19,27 @@ Connecting to EKS running in the private subnet of AWS VPC from your DevBox. 1. Go to **Amazon Elastic Kubernetes Service > Clusters**. 2. Go to your **DevBox** and install awscli: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo apt install awscli ``` -{% endcode %} 3. Download the **kubectl** binaries: -{% code overflow="wrap" lineNumbers="false" %} ``` curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" ``` -{% endcode %} 4. Install **kubectl**: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` -{% endcode %} 5. Check if the cluster is accessible: -{% code overflow="wrap" lineNumbers="false" %} ``` kubectl get svc ``` -{% endcode %} ![AWS EKS Access](../../../.gitbook/assets/eks-access.png) @@ -69,42 +60,33 @@ kubectl get svc 1. Go to your **DevBox** and install awscli: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo apt install awscli ``` -{% endcode %} 2. Download **kubectl** binaries: -{% code overflow="wrap" lineNumbers="false" %} ``` curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" ``` -{% endcode %} 3. Install **kubectl**: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` -{% endcode %} ### Step 3: Accessing the EKS Cluster 1. Click on your AWS username at the top right corner and go to **Security credentials**. In the **Access keys** section, click on **Create access key**. Create the key and save the **CSV** file. 2. In your **DevBox**, use the csv credentials to configure the awscli to your account: -{% code overflow="wrap" lineNumbers="false" %} ``` aws configure ``` -{% endcode %} 3. Check if the cluster is accessible: -{% code overflow="wrap" %} ``` kubectl get svc diff --git a/how-to-guides/cloud-services/aws/connect-to-an-rds-instance.md b/how-to-guides/cloud-services/aws/connect-to-an-rds-instance.md index 3503c92..02be2c2 100644 --- a/how-to-guides/cloud-services/aws/connect-to-an-rds-instance.md +++ b/how-to-guides/cloud-services/aws/connect-to-an-rds-instance.md @@ -1,7 +1,6 @@ --- title: RDS --- -# RDS Connecting to an RDS running in the private subnet of AWS VPC to your DevBox. @@ -35,11 +34,10 @@ sudo apt install mysql-client To access the database: -{% code %} ``` mysql -h -u --database -p ``` -{% endcode %} + {% endtab %} {% tab title="PostgreSQL" %} @@ -51,11 +49,10 @@ sudo apt install postgresql-client To access the database: -{% code %} ``` psql -h --username -d --password ``` -{% endcode %} + {% endtab %} {% endtabs %} diff --git a/how-to-guides/cloud-services/aws/connect-to-an-s3-bucket.md b/how-to-guides/cloud-services/aws/connect-to-an-s3-bucket.md index 7b9ebe8..08e9276 100644 --- a/how-to-guides/cloud-services/aws/connect-to-an-s3-bucket.md +++ b/how-to-guides/cloud-services/aws/connect-to-an-s3-bucket.md @@ -1,7 +1,6 @@ --- title: Connect to S3 --- -# Connect to S3 ## Using the AWS CLI diff --git a/how-to-guides/cloud-services/aws/connect-to-dynamodb.md b/how-to-guides/cloud-services/aws/connect-to-dynamodb.md index 4b7cc56..c7df88e 100644 --- a/how-to-guides/cloud-services/aws/connect-to-dynamodb.md +++ b/how-to-guides/cloud-services/aws/connect-to-dynamodb.md @@ -1,7 +1,6 @@ --- title: AWS DynamoDB --- -# AWS DynamoDB This guide explains connecting to an AWS DynamoDB service running on AWS infrastructure from your DevBox. @@ -24,7 +23,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" build: @@ -37,7 +35,6 @@ build: unzip awscliv2.zip sudo ./aws/install ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -57,11 +54,9 @@ Now, this is where the real task begins. After downloading the `aws' cli package 3. Click `create access key` and note down the **Secret Access Key** as this will only be shown once. 4. Go to your DevBox and use the following command to configure the `aws` cli: -{% code overflow="wrap" lineNumbers="false" %} ``` aws configure ``` -{% endcode %} 5. Enter the **Access Key** and **Secret Access Key** when prompted. 6. Enter your default **Region** of choice, and your `aws` cli setup will be completed. @@ -70,10 +65,8 @@ aws configure Now, with the above steps, your AWS DynamoDB connections are completed, and you can check that with the following command: -{% code overflow="wrap" lineNumbers="false" %} ``` aws dynamodb list-tables ``` -{% endcode %} ![GCP DynamoDB Creation and Access](../../../.gitbook/assets/aws-dynamodb-creation.png) diff --git a/how-to-guides/cloud-services/aws/connect-to-elasticache.md b/how-to-guides/cloud-services/aws/connect-to-elasticache.md index b38516a..eefed49 100644 --- a/how-to-guides/cloud-services/aws/connect-to-elasticache.md +++ b/how-to-guides/cloud-services/aws/connect-to-elasticache.md @@ -2,7 +2,6 @@ title: ElastiCache --- -# ElastiCache Connecting to ElastiCache running in the private subnet of AWS VPC from your DevBox. @@ -26,19 +25,15 @@ Connecting to ElastiCache running in the private subnet of AWS VPC from your Dev 4. Go to your **DevBox** and install the Redis CLI: -{% code lineNumbers="false" %} ``` sudo apt install redis-tools ``` -{% endcode %} 5. Access the cluster using the CLI: -{% code lineNumbers="false" %} ``` redis-cli -h -p ``` -{% endcode %} ![AWS ElastiCache Access](../../../.gitbook/assets/elasticache-access.png) @@ -64,18 +59,14 @@ redis-cli -h -p 2. Go to your **DevBox** and install the Redis CLI: -{% code lineNumbers="false" %} ``` sudo apt install redis-tools ``` -{% endcode %} 3. Access the cluster using the CLI: -{% code lineNumbers="false" %} ``` redis-cli -h -p ``` -{% endcode %} ![AWS ElastiCache Access](../../../.gitbook/assets/elasticache-access.png) diff --git a/how-to-guides/cloud-services/aws/connect-to-opensearch.md b/how-to-guides/cloud-services/aws/connect-to-opensearch.md index 228021f..9271d35 100644 --- a/how-to-guides/cloud-services/aws/connect-to-opensearch.md +++ b/how-to-guides/cloud-services/aws/connect-to-opensearch.md @@ -1,7 +1,6 @@ --- title: OpenSearch --- -# OpenSearch Connecting to OpenSearch running in the private subnet of AWS VPC from your DevBox. @@ -24,11 +23,9 @@ Connecting to OpenSearch running in the private subnet of AWS VPC from your DevB 3. Go to your **DevBox** and connect to Service: -{% code lineNumbers="false" %} ``` curl -X GET "" ``` -{% endcode %} ![AWS OpenSearch Access](../../../.gitbook/assets/opensearch-access.png) @@ -53,10 +50,8 @@ curl -X GET "" 2. Go to your **DevBox** and connect to Service: -{% code lineNumbers="false" %} ``` curl -X GET "" ``` -{% endcode %} ![AWS OpenSearch Access](../../../.gitbook/assets/opensearch-access.png) diff --git a/how-to-guides/cloud-services/aws/connect-to-sqs.md b/how-to-guides/cloud-services/aws/connect-to-sqs.md index 8489ed6..67ac27d 100644 --- a/how-to-guides/cloud-services/aws/connect-to-sqs.md +++ b/how-to-guides/cloud-services/aws/connect-to-sqs.md @@ -1,7 +1,6 @@ --- title: Connect to SQS --- -# Connect to SQS ## Using the AWS CLI diff --git a/how-to-guides/cloud-services/aws/ecs-local.md b/how-to-guides/cloud-services/aws/ecs-local.md index 396c62a..24f8328 100644 --- a/how-to-guides/cloud-services/aws/ecs-local.md +++ b/how-to-guides/cloud-services/aws/ecs-local.md @@ -1,7 +1,6 @@ --- title: ECS (local) --- -# ECS (local) ## Installation guide diff --git a/how-to-guides/cloud-services/aws/ecs.md b/how-to-guides/cloud-services/aws/ecs.md index eabbd10..f42e888 100644 --- a/how-to-guides/cloud-services/aws/ecs.md +++ b/how-to-guides/cloud-services/aws/ecs.md @@ -1,7 +1,6 @@ --- title: ECS --- -# ECS ## Installation guide @@ -31,9 +30,7 @@ chmod 700 ./ecs-anywhere-install.sh sudo ./ecs-anywhere-install.sh --region "" --cluster "" --activation-id "" --activation-code "" ``` -{% hint style="info" %} -Note: the installation script will also install Docker. -{% endhint %} +> Note: the installation script will also install Docker. The new instance should now be visible in the ECS console under **Your Cluster > Infrastructure > Container instances** as "External" instance type. @@ -61,9 +58,7 @@ docker volumes ls
-{% hint style="warning" %} -If you select "Configure at deployment" in your task definition, you might not be able to deploy it to the external instance type, because this configuration only supports Amazon EBS, which is not available with external instances. -{% endhint %} +> If you select "Configure at deployment" in your task definition, you might not be able to deploy it to the external instance type, because this configuration only supports Amazon EBS, which is not available with external instances. ## Recipe example diff --git a/how-to-guides/cloud-services/azure/README.md b/how-to-guides/cloud-services/azure/README.md index 94a73df..c27c5d8 100644 --- a/how-to-guides/cloud-services/azure/README.md +++ b/how-to-guides/cloud-services/azure/README.md @@ -1,7 +1,6 @@ --- title: Azure --- -# Azure
diff --git a/how-to-guides/cloud-services/azure/configuring-storage-account.md b/how-to-guides/cloud-services/azure/configuring-storage-account.md index 59def09..0f4c608 100644 --- a/how-to-guides/cloud-services/azure/configuring-storage-account.md +++ b/how-to-guides/cloud-services/azure/configuring-storage-account.md @@ -1,7 +1,6 @@ --- title: Azure Storage Account --- -# Azure Storage Account Configuring the Azure Storage Account to access its endpoint from DevBox. @@ -43,11 +42,9 @@ Now follow the below steps to configure the Storage Account: To verify if you can access the storage account endpoint from your DevBox, just use the following command in your DevBox: -{% code lineNumbers="false" %} ``` nslookup ..core.windows.net ``` -{% endcode %} ![Azure Storage Account access](../../../.gitbook/assets/azure-storage-account-access.png) @@ -75,10 +72,8 @@ To verify if you can access the Storage Account, follow the below steps: 1. Go to the **DevBox**. 2. Use the following command to see if the private endpoint is accessible to you: -{% code lineNumbers="false" %} ``` nslookup ..core.windows.net ``` -{% endcode %} ![Azure Storage Account access](../../../.gitbook/assets/azure-storage-account-access.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-ai.md b/how-to-guides/cloud-services/azure/connecting-to-ai.md index 815f056..21c0720 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-ai.md +++ b/how-to-guides/cloud-services/azure/connecting-to-ai.md @@ -1,7 +1,6 @@ --- title: Azure AI Services --- -# Azure AI Services This guide explains connecting to an Azure AI service running on Azure infrastructure from your DevBox. @@ -31,7 +30,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -43,7 +41,6 @@ build: command: | sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -85,11 +82,9 @@ Now follow the below steps to access the AI Services on your DevBox: 5. Copy the API Key and export it to your environmental variables using the following command: -{% code lineNumbers="false" %} ``` export TOKEN= ``` -{% endcode %} 6. Below that, you will find code snippets for several languages and frameworks. For this guide, we will demonstrate the secure connection with `curl`. 7. Copy the code snippet and place it in your **TOKEN** environmental variable. @@ -128,7 +123,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -140,7 +134,6 @@ build: command: | sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -168,11 +161,9 @@ Now follow the below steps to access the AI Services on your DevBox: 5. Copy the API Key and export it to your environmental variables using the following command: -{% code lineNumbers="false" %} ``` export TOKEN= ``` -{% endcode %} 6. Below, you will find code snippets for several languages and frameworks. This guide will demonstrate the secure connection with `curl`. 7. Copy the code snippet and place it in your **TOKEN** environmental variable. diff --git a/how-to-guides/cloud-services/azure/connecting-to-app-service.md b/how-to-guides/cloud-services/azure/connecting-to-app-service.md index 9a7a8cc..a118491 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-app-service.md +++ b/how-to-guides/cloud-services/azure/connecting-to-app-service.md @@ -1,7 +1,6 @@ --- title: Azure App Services --- -# Azure App Services You are connecting to an App Service running on your Azure infrastructure from your DevBox. @@ -45,20 +44,16 @@ Follow the Below steps to access your Web App from your DevBox : 1. Connect to the workspace using the following command: -{% code lineNumbers="false" %} ``` sudo dz workspace connect ``` -{% endcode %} 2. Copy the **Default domain** of the **App Service** you want to access. 3. Connect to the **App Service**: -{% code lineNumbers="false" %} ``` curl -X GET ``` -{% endcode %} ![Azure App Service Access](../../../.gitbook/assets/azure-app-service-access.png) @@ -183,19 +178,15 @@ Follow the Below steps to access your Web App from your DevBox : 1. Connect to the workspace using the following command: -{% code lineNumbers="false" %} ``` sudo dz workspace connect ``` -{% endcode %} 2. Copy the **Default domain** of the **App Service** you want to access. 3. Connect to the **App Service**: -{% code lineNumbers="false" %} ``` curl -X GET ``` -{% endcode %} ![Azure App Service Access](../../../.gitbook/assets/azure-app-service-access.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-blob-storage.md b/how-to-guides/cloud-services/azure/connecting-to-blob-storage.md index c553fbf..4c958fa 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-blob-storage.md +++ b/how-to-guides/cloud-services/azure/connecting-to-blob-storage.md @@ -1,7 +1,6 @@ --- title: Azure Blob Storage --- -# Azure Blob Storage Connecting to an Azure Blob Storage from your DevBox. @@ -27,19 +26,15 @@ Now follow the below steps to access the Blob Storage on your DevBox: 1. Go to DevBox and install the Azure CLI tool using the following command: -{% code lineNumbers="false" %} ``` sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 2. Login into your Azure account using the `login` command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 3. After you have completed your authentication, go to **Home > Storage Accounts** and select your storage account. 4. Then go to the **Security + Networking > Access Keys** section and note down either of the two access keys presented to you. @@ -50,7 +45,6 @@ az login To Upload a file as Blob to the container, use the following command: -{% code %} ``` az storage blob upload \ --account-name \ @@ -59,7 +53,6 @@ az storage blob upload \ --name myFile.txt \ --file myFile.txt \ ``` -{% endcode %} ![Azure Blob Storage Upload](../../../.gitbook/assets/azure-blob-upload.png) @@ -69,7 +62,6 @@ az storage blob upload \ To Download a Blob from the container, use the following command: -{% code %} ``` az storage blob download \ --account-name \ @@ -78,7 +70,6 @@ az storage blob download \ --name myFile.txt \ --file myFile.txt \ ``` -{% endcode %} ![Azure Blob Storage Download 1](../../../.gitbook/assets/azure-blob-download-1.png) ![Azure Blob Storage Download 2](../../../.gitbook/assets/azure-blob-download-2.png) @@ -89,7 +80,6 @@ az storage blob download \ To list all the blobs in the container, use the following command: -{% code %} ``` az storage blob list \ --account-name \ @@ -97,7 +87,6 @@ az storage blob list \ --container-name \ --output table ``` -{% endcode %} ![Azure Blob Storage List](../../../.gitbook/assets/azure-blob-list.png) @@ -125,19 +114,15 @@ After creating the container, you must install and authenticate your Azure CLI t 1. Go to DevBox and install the Azure CLI tool using the following command: -{% code lineNumbers="false" %} ``` sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 2. Login into your Azure account using the `login` command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 3. You may use the following command to Upload, Download, or list the Blob in the container: @@ -146,7 +131,6 @@ az login To Upload a file as Blob to the container, use the following command: -{% code %} ``` az storage blob upload \ --account-name \ @@ -155,7 +139,6 @@ az storage blob upload \ --name myFile.txt \ --file myFile.txt \ ``` -{% endcode %} ![Azure Blob Storage Upload](../../../.gitbook/assets/azure-blob-upload.png) @@ -165,7 +148,6 @@ az storage blob upload \ To Download a file from the container, use the following command: -{% code %} ``` az storage blob download \ --account-name \ @@ -174,7 +156,6 @@ az storage blob download \ --name myFile.txt \ --file myFile.txt \ ``` -{% endcode %} ![Azure Blob Storage Download 1](../../../.gitbook/assets/azure-blob-download-1.png) ![Azure Blob Storage Download 2](../../../.gitbook/assets/azure-blob-download-2.png) @@ -185,7 +166,6 @@ az storage blob download \ To list all the blobs in the container, use the following command: -{% code %} ``` az storage blob list \ --account-name \ @@ -193,7 +173,6 @@ az storage blob list \ --container-name \ --output table ``` -{% endcode %} ![Azure Blob Storage List](../../../.gitbook/assets/azure-blob-list.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-container-instance.md b/how-to-guides/cloud-services/azure/connecting-to-container-instance.md index b7c6bfc..8a9a179 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-container-instance.md +++ b/how-to-guides/cloud-services/azure/connecting-to-container-instance.md @@ -1,7 +1,6 @@ --- title: Azure Container Instance --- -# Azure Container Instance You are connecting to a Container Instance running in the private subnet of Azure Virtual Network (VNET) from your DevBox. @@ -18,9 +17,7 @@ Before you begin, follow the [Connecting to Azure](../../existing-network/connec ## Existing Azure Container Instance -{% hint="info" %} -Please make sure your container has a **Private IP Address** and check if the container is housed in the same **Virtual Network** as the **Bastion Host**. -{% endhint %} +> Please make sure your container has a **Private IP Address** and check if the container is housed in the same **Virtual Network** as the **Bastion Host**. ### Step 1: Creating a Workspace @@ -38,19 +35,15 @@ Follow the Below steps to access your container application from your DevBox : 1. Connect to the workspace using the following command: -{% code lineNumbers="false" %} ``` sudo dz workspace connect ``` -{% endcode %} 2. You can access the application running in the container using the `curl` command: -{% code lineNumbers="false" %} ``` curl -X GET ``` -{% endcode %} ![Azure Container Access](../../../.gitbook/assets/azure-container-access.png) @@ -85,18 +78,14 @@ Follow the Below steps to access your container application from your DevBox : 1. Connect to the workspace using the following command: -{% code lineNumbers="false" %} ``` sudo dz workspace connect ``` -{% endcode %} 2. You can access the application running in the container using the `curl` command: -{% code lineNumbers="false" %} ``` curl -X GET ``` -{% endcode %} ![Azure Container Access](../../../.gitbook/assets/azure-container-access.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-db.md b/how-to-guides/cloud-services/azure/connecting-to-db.md index 68d6803..79d2ae8 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-db.md +++ b/how-to-guides/cloud-services/azure/connecting-to-db.md @@ -1,7 +1,6 @@ --- title: Azure Database --- -# Azure Database You are connecting to a Azure database instance running in the private subnet of Azure Virtual Network (VNET) from your DevBox. @@ -37,11 +36,10 @@ sudo apt install mysql-client To access the database: -{% code %} ``` mysql -h -u --database -p ``` -{% endcode %} + {% endtab %} {% tab title="PostgreSQL" %} @@ -53,11 +51,10 @@ sudo apt install postgresql-client To access the database: -{% code %} ``` psql -h --username -d --password ``` -{% endcode %} + {% endtab %} {% endtabs %} @@ -123,11 +120,10 @@ sudo apt install mysql-client To access the database: -{% code %} ``` mysql -h -u --database -p ``` -{% endcode %} + {% endtab %} {% tab title="PostgreSQL" %} @@ -139,11 +135,10 @@ sudo apt install postgresql-client To access the database: -{% code %} ``` psql -h --username -d --password ``` -{% endcode %} + {% endtab %} {% endtabs %} diff --git a/how-to-guides/cloud-services/azure/connecting-to-elastic-san.md b/how-to-guides/cloud-services/azure/connecting-to-elastic-san.md index cb9a418..766ca1f 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-elastic-san.md +++ b/how-to-guides/cloud-services/azure/connecting-to-elastic-san.md @@ -1,7 +1,6 @@ --- title: Azure Elastic SAN --- -# Azure Elastic SAN You connect to an Azure Elastic SAN Service running on Azure infrastructure from your DevBox. @@ -29,7 +28,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -38,7 +36,6 @@ build: - type: apt-get packages: ["build-essential", "curl", "git", "nano", "software-properties-common", "ssh", "sudo", "tar", "unzip", "vim", "wget", "zip", "python3", "libpython3-dev"] ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -61,9 +58,7 @@ To connect to the Elastic SAN volumes, we first need to create a Volume Group an 6. Select **Yes** for **Integrate with private DNS zone** option, and click on **Ok**. 7. After creating the endpoint, click on **Create**. -{% hint style="info" %} -You can also add your VNET by clicking on **Create** under the **Virtual Networks** section and entering the details of the VNET, which exists in the same region as the Elastic SAN instance. -{% endhint %} +> You can also add your VNET by clicking on **Create** under the **Virtual Networks** section and entering the details of the VNET, which exists in the same region as the Elastic SAN instance. ### Step 4: Creating a Volume @@ -83,20 +78,16 @@ Now you need to follow the below steps to connect to DevBox: 1. Connect to the workspace from your terminal. 2. Create a Python script by using the following command: -{% code %} ``` sudo nano .py ``` -{% endcode %} 3. Paste in the connection script we got from the volume. 4. Run the Python file with elevated access to make the connection: -{% code %} ``` sudo python3 .py ``` -{% endcode %} ![Azure Elastic SAN access](../../../.gitbook/assets/azure-elastic-san-access.png) @@ -111,15 +102,11 @@ If you need to make a new Elastic SAN instance and access it through DevZero's n 3. Then input your SAN **Name**, **Region**, and **Redundancy** type. 4. You can allocate the desired SAN size in the **Resource provisioning on Elastic SAN** section. -{% hint style="info" %} -Remember that the size of your SAN is directly proportional to the IOPS (Input/Output operations per second) and bandwidth allocated to the instance. -{% endhint %} +> Remember that the size of your SAN is directly proportional to the IOPS (Input/Output operations per second) and bandwidth allocated to the instance. 5. In the **Networking** section, choose the **Disabled** option for **Public network access**. -{% hint style="info" %} -You can also choose the **Enabled** option and connect to a VNET if you have a VNET in the same **Region** as the Elastic SAN instance. -{% endhint %} +> You can also choose the **Enabled** option and connect to a VNET if you have a VNET in the same **Region** as the Elastic SAN instance. 6. Click on **Review + Create** and click on **Create**. @@ -131,7 +118,6 @@ You can also choose the **Enabled** option and connect to a VNET if you have a V 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -140,7 +126,6 @@ build: - type: apt-get packages: ["build-essential", "curl", "git", "nano", "software-properties-common", "ssh", "sudo", "tar", "unzip", "vim", "wget", "zip", "python3", "libpython3-dev"] ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -163,9 +148,7 @@ To connect to the Elastic SAN volumes, we first need to create a Volume Group an 6. Select **Yes** for **Integrate with private DNS zone** option, and click on **Ok**. 7. After creating the endpoint, click on **Create**. -{% hint style="info" %} -You can also add your VNET by clicking on **Create** under the **Virtual Networks** section and entering the details of the VNET, which exists in the same region as the Elastic SAN instance. -{% endhint %} +> You can also add your VNET by clicking on **Create** under the **Virtual Networks** section and entering the details of the VNET, which exists in the same region as the Elastic SAN instance. ### Step 5: Creating a Volume @@ -185,19 +168,15 @@ Now, you need to follow the below steps to connect to DevBox: 1. Connect to the workspace from your terminal. 2. Create a Python script by using the following command: -{% code %} ``` sudo nano .py ``` -{% endcode %} 3. paste in the connection script we got from the volume. 4. Run the Python file with elevated access to make the connection: -{% code %} ``` sudo python3 .py ``` -{% endcode %} ![Azure Elastic SAN access](../../../.gitbook/assets/azure-elastic-san-access.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-file-storage.md b/how-to-guides/cloud-services/azure/connecting-to-file-storage.md index 4e538c4..0ea22bc 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-file-storage.md +++ b/how-to-guides/cloud-services/azure/connecting-to-file-storage.md @@ -1,7 +1,6 @@ --- title: Azure File Storage --- -# Azure File Storage Connecting to an Azure File Storage from your DevBox. @@ -32,7 +31,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -44,7 +42,6 @@ build: command: | sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -61,11 +58,9 @@ Now follow the below steps to access the File Storage on your DevBox: 1. Connect to DevBox and login into your Azure account using the `login` command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 2. After you have completed your authentication, go to **Home > Storage Accounts** and select your storage account. 4. Then go to the **Security + Networking > Access Keys** section and note down either of the two access keys presented to you. @@ -76,7 +71,6 @@ az login To Upload a file to the file share, use the following command: -{% code %} ``` az storage file upload \ --account-name \ @@ -85,7 +79,6 @@ az storage file upload \ --source "file-name.txt" \ --path "/.txt" ``` -{% endcode %} Here, the `--source` tag refers to the File you want to upload, and the `--path` tag specifies where you want to upload the File, specifying a directory and output file name. @@ -97,7 +90,6 @@ Here, the `--source` tag refers to the File you want to upload, and the `--path` To Download a file from the file share, use the following command: -{% code %} ``` az storage file upload \ --account-name \ @@ -107,7 +99,6 @@ az storage file upload \ --dest ".txt" \ --output none ``` -{% endcode %} Here, the `--path` tag refers to the terminal path of the File you want to download from your file share and the `--dest` tag specifies how and where you want to save your File by specifying a directory and output file name. @@ -119,7 +110,6 @@ Here, the `--path` tag refers to the terminal path of the File you want to downl To list all the files in the file share, use the following command: -{% code %} ``` az storage file list \ --account-name \ @@ -128,7 +118,6 @@ az storage file list \ --path "" \ --output table ``` -{% endcode %} ![Azure File Storage List](../../../.gitbook/assets/azure-file-list.png) @@ -158,7 +147,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -170,7 +158,6 @@ build: command: | sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -187,15 +174,12 @@ After creating the File Share, you must install and authenticate your Azure CLI 1. Connect to your DevBox and login into your Azure account using the `login` command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 2. Use the following command to create a directory in the File Share: -{% code %} ``` az storage directory create \ --account-name \ @@ -204,7 +188,6 @@ az storage directory create \ --name \ --output none ``` -{% endcode %} ![Azure File Storage Directory Creation](../../../.gitbook/assets/azure-file-directory-creation.png) @@ -215,7 +198,6 @@ az storage directory create \ To Upload a file to the file share, use the following command: -{% code %} ``` az storage file upload \ --account-name \ @@ -224,7 +206,6 @@ az storage file upload \ --source "file-name.txt" \ --path "/.txt" ``` -{% endcode %} Here, the `--source` tag refers to the file you want to upload, and the `--path` tag refers to where you want to upload the file by specifying a Filectory and output file name. @@ -236,7 +217,6 @@ Here, the `--source` tag refers to the file you want to upload, and the `--path` To Download a file from the file share, use the following command: -{% code %} ``` az storage file upload \ --account-name \ @@ -246,7 +226,6 @@ az storage file upload \ --dest ".txt" \ --output none ``` -{% endcode %} Here, the `--path` tag refers to the terminal path of the file you want to downfile from your file share, and `--dest` tag refers to how and where you want to save your File by specifying a directory and output file name. @@ -258,7 +237,6 @@ Here, the `--path` tag refers to the terminal path of the file you want to downf To list all the files in the file share, use the following command: -{% code %} ``` az storage file list \ --account-name \ @@ -267,7 +245,6 @@ az storage file list \ --path "" \ --output table ``` -{% endcode %} ![Azure File Storage List](../../../.gitbook/assets/azure-file-list.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-key-vault.md b/how-to-guides/cloud-services/azure/connecting-to-key-vault.md index cc0f839..1014b6b 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-key-vault.md +++ b/how-to-guides/cloud-services/azure/connecting-to-key-vault.md @@ -1,7 +1,6 @@ --- title: Azure Key Vault --- -# Azure Key Vault You are connecting to an Azure Key Vault from your DevBox. @@ -41,22 +40,18 @@ Now, to retrieve the value from the secrets using the API, you need to set **Ser 3. Go to **All applications** and click on the app you just created. 4. Copy the **Client ID** and **Tenant ID** and add it to the DevBox environmental variables. -{%code%} ``` export AZURE_CLIENT_ID= export AZURE_TENANT_ID= ``` -{%endcode%} 5. Click on **Client credentials** and click on **New client secret**. 6. Enter the description if you want to, and click on **Add**. 7. Copy the **Value** of the client secret you just created and add it to the environmental variables of your DevBox by using the following command. -{%code%} ``` export AZURE_CLIENT_SECRET= ``` -{%endcode%} 8. Now, go to **Home > Key Vaults** and click on the key vault you want to access. 9. Then go to **Access Control (IAM)** and click on **Add role assignment**. @@ -70,16 +65,13 @@ Here we are using Python to show the key vault usage, you can choose other progr 1. Install the required packages using the following command: -{%code%} ``` pip install azure-identity pip install azure-keyvault-secrets ``` -{%endcode%} 2. Write the following Python script to retrieve the secret: -{%code%} ``` from azure.identity import ClientSecretCredential from azure.keyvault.secrets import SecretClient @@ -90,7 +82,6 @@ tenant_id = os.environ['TENANT_ID'] client_secret = os.environ['CLIENT_SECRET'] vault_url = f"https://test-vault-devzero.vault.azure.net/" - secret_name = "Devzero-key" credentials = ClientSecretCredential( @@ -105,7 +96,6 @@ secret = secret_client.get_secret(secret_name) print("The secret value is :" + secret.value) ``` -{%endcode%} ![Azure Key Vault access](../../../.gitbook/assets/azure-key-vault-access.png) @@ -150,22 +140,18 @@ Now, to retrieve the value from the secrets using the API, you need to set **Ser 3. Go to **All applications** and click on the app you just created. 4. Copy the **Client ID** and **Tenant ID** and add it to the DevBox environmental variables. -{%code%} ``` export AZURE_CLIENT_ID= export AZURE_TENANT_ID= ``` -{%endcode%} 5. Click on **Client credentials** and click on **New client secret**. 6. Enter the description if you want to, and click on **Add**. 7. Copy the **Value** of the client secret you just created and add it to the environmental variables of your DevBox by using the following command. -{%code%} ``` export AZURE_CLIENT_SECRET= ``` -{%endcode%} ![Azure Key Vault service principals](../../../.gitbook/assets/azure-key-vault-principal.png) @@ -181,16 +167,13 @@ Here we are using Python to show the key vault usage, you can choose other progr 1. Install the required packages using the following command: -{%code%} ``` pip install azure-identity pip install azure-key vault-secrets ``` -{%endcode%} 2. Write the following Python script to retrieve the secret: -{%code%} ``` from azure.identity import ClientSecretCredential from azure.keyvault.secrets import SecretClient @@ -201,7 +184,6 @@ tenant_id = os.environ['TENANT_ID'] client_secret = os.environ['CLIENT_SECRET'] vault_url = f"https://test-vault-devzero.vault.azure.net/" - secret_name = "devzero-key" credentials = ClientSecretCredential( @@ -216,6 +198,5 @@ secret = secret_client.get_secret(secret_name) print("The secret value is :" + secret.value) ``` -{%endcode%} ![Azure Key Vault access](../../../.gitbook/assets/azure-key-vault-access.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-ks.md b/how-to-guides/cloud-services/azure/connecting-to-ks.md index 47797da..7507f47 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-ks.md +++ b/how-to-guides/cloud-services/azure/connecting-to-ks.md @@ -1,7 +1,6 @@ --- title: Azure Kubernetes Service --- -# Azure Kubernetes Service You are connecting to a Kubernetes cluster running in the private subnet of Azure Virtual Network (VNET) from your DevBox. @@ -25,35 +24,27 @@ If the above criteria are followed, then log into your DevBox and follow these s 1. Go to your **DevBox** and install Azure CLI: -{% code lineNumbers="false" %} ``` sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 2. After the installation is successful, you need to authenticate your Microsoft Azure account with Azure CLI using the following command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 3. Following your setup with Azure CLI, you also need to download the **kubectl** binaries: -{% code lineNumbers="false" %} ``` curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" ``` -{% endcode %} 4. Install **kubectl**: -{% code lineNumbers="false" %} ``` sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` -{% endcode %} ### Step 2: Accessing your AKS Cluster from DevBox @@ -61,27 +52,21 @@ After your initial setup is done, your DevBox should be ready for accessing the 1. You need to select your **Subscription ID** in Azure Cli with the following command: -{% code lineNumbers="false" %} ``` az account set --subscription ``` -{% endcode %} 2. Use the following command to connect to your cluster: -{% code lineNumbers="false" %} ``` az aks get-credentials --resource-group --name --overwrite-existing ``` -{% endcode %} 2. Check if the cluster is accessible: -{% code %} ``` kubectl get svc ``` -{% endcode %} ![GCP GKE -> Devbox](../../../.gitbook/assets/azure-ks-access.png) @@ -107,35 +92,27 @@ Now that you have created the cluster, you need to authenticate your DevBox with 1. Go to your **DevBox** and install Azure CLI: -{% code lineNumbers="false" %} ``` sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 2. After the installation is successful, you need to authenticate your Microsoft Azure account with Azure CLI using the following command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 3. Following your setup with Azure CLI, you also need to download the **kubectl** binaries: -{% code lineNumbers="false" %} ``` curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" ``` -{% endcode %} 4. Install **kubectl**: -{% code lineNumbers="false" %} ``` sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` -{% endcode %} ### Step 3: Accessing your Azure Kubernetes Cluster from DevBox @@ -143,26 +120,20 @@ After your initial setup is done, your DevBox should be ready for accessing the 1. You need to select your **Subscription ID** in Azure CLI with the following command: -{% code lineNumbers="false" %} ``` az account set --subscription ``` -{% endcode %} 2. Use the following command to connect to your cluster: -{% code lineNumbers="false" %} ``` az aks get-credentials --resource-group --name --overwrite-existing ``` -{% endcode %} 2. Check if the cluster is accessible: -{% code %} ``` kubectl get svc ``` -{% endcode %} ![GCP GKE -> Devbox](../../../.gitbook/assets/azure-ks-access.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-table-storage.md b/how-to-guides/cloud-services/azure/connecting-to-table-storage.md index 4a309b2..88a5d46 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-table-storage.md +++ b/how-to-guides/cloud-services/azure/connecting-to-table-storage.md @@ -1,7 +1,6 @@ --- title: Azure Table Storage --- -# Azure Table Storage Connecting to an Azure Table Storage from your DevBox. @@ -27,19 +26,15 @@ Now follow the below steps to access the Table Storage on your DevBox: 1. Go to DevBox and install the Azure CLI tool using the following command: -{% code lineNumbers="false" %} ``` sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 2. Login into your Azure account using the `login` command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 3. After you have completed your authentication, go to **Home > Storage Accounts** and select your storage account. 4. Then go to the **Security + Networking > Access Keys** section and note down either of the two access keys presented to you. @@ -50,14 +45,12 @@ az login To check the **Existence** of the table, use the following command: -{% code %} ``` az storage table exists \ --account-name \ --account-key \ --name ``` -{% endcode %} ![Azure Table Storage Exists](../../../.gitbook/assets/azure-table-exists.png) @@ -67,13 +60,11 @@ az storage table exists \ To **List** all the available tables, use the following command: -{% code %} ``` az storage table list \ --account-name \ --account-key ``` -{% endcode %} ![Azure Table Storage List](../../../.gitbook/assets/azure-table-list.png) @@ -101,19 +92,15 @@ After creating the table, you must install and authenticate your Azure CLI to ea 1. Go to DevBox and install the Azure CLI tool using the following command: -{% code lineNumbers="false" %} ``` sudo curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash ``` -{% endcode %} 2. Login into your Azure account using the `login` command: -{% code lineNumbers="false" %} ``` az login ``` -{% endcode %} 3. You may use the following command to Check existence and List the available tables: @@ -122,14 +109,12 @@ az login To check the **Existence** of the table, use the following command: -{% code %} ``` az storage table exists \ --account-name \ --account-key \ --name ``` -{% endcode %} ![Azure Table Storage Exists](../../../.gitbook/assets/azure-table-exists.png) @@ -139,13 +124,11 @@ az storage table exists \ To **List** all the available tables, use the following command: -{% code %} ``` az storage table list \ --account-name \ --account-key ``` -{% endcode %} ![Azure Table Storage List](../../../.gitbook/assets/azure-table-list.png) diff --git a/how-to-guides/cloud-services/azure/connecting-to-vm.md b/how-to-guides/cloud-services/azure/connecting-to-vm.md index b62e10e..5030f1e 100644 --- a/how-to-guides/cloud-services/azure/connecting-to-vm.md +++ b/how-to-guides/cloud-services/azure/connecting-to-vm.md @@ -1,7 +1,6 @@ --- title: Azure Virtual Machine --- -# Azure Virtual Machine You are connecting to a Virtual Machine running in the private subnet of Azure Virtual Network (VNET) from your DevBox. @@ -25,11 +24,9 @@ If the above criteria are followed, then log into your DevBox and SSH into the p 3. Copy the private SSH key within the `.ssh` directory. 4. Connect to the virtual machine: -{% code lineNumbers="false" %} ``` ssh -i "path/to/private/key" username@instance-private-ip ``` -{% endcode %} ![Azure VM Access](../../../.gitbook/assets/azure-vm-access.png) @@ -54,10 +51,8 @@ If you need to make a new virtual machine running in a private subnet and access 1. Go to **DevBox** and make a copy of the key pair. 2. Connect to the Virtual Machine using ssh and the new key pair: -{% code lineNumbers="false" %} ``` ssh -i "path/to/private/key" username@instance-ip ``` -{% endcode %} ![Azure VM Access](../../../.gitbook/assets/azure-vm-access.png) diff --git a/how-to-guides/cloud-services/azure/setting-up-dns-private-resolver.md b/how-to-guides/cloud-services/azure/setting-up-dns-private-resolver.md index 42e63f8..e43a97b 100644 --- a/how-to-guides/cloud-services/azure/setting-up-dns-private-resolver.md +++ b/how-to-guides/cloud-services/azure/setting-up-dns-private-resolver.md @@ -1,7 +1,6 @@ --- title: Azure DNS Private Resolver --- -# Azure DNS Private Resolver Setting up a DNS Private Resolver so that you can access the Azure Private DNS zones connected to your Azure Virtual Network (VNET). @@ -41,31 +40,25 @@ After you are done with creating the DNS Private Resolver, you need to add the D 2. Then navigate to **Settings > Inbound Endpoints** and note down the IP Address of the inbound endpoint which you created. 3. Go to **DevBox** and enter the following command: -{% code lineNumbers="false" %} ``` sudo nano /etc/resolv.conf ``` -{% endcode %} we need to add the IP address to this configuration file so that the DevZero Network can use the Conditional Forwarder. 4. Enter the following line to the `resolv.conf` file: -{% code lineNumbers="false" %} ``` nameserver ``` -{% endcode %} save the file and you will now be able to access the domains within the Azure DNS Private Zones. For Example, we have a DNS Private Zone named `privatelink.postgres.database.azure.com` and it houses a private domain endpoint named `test-db-devzero.postgres.database.azure.com`. You can verify the setup by using `nslookup`: -{% code lineNumbers="false" %} ``` nslookup ``` -{% endcode %} If everything goes well then you should see a output similar to this. diff --git a/how-to-guides/cloud-services/gcp/README.md b/how-to-guides/cloud-services/gcp/README.md index 1f988b4..3c843c2 100644 --- a/how-to-guides/cloud-services/gcp/README.md +++ b/how-to-guides/cloud-services/gcp/README.md @@ -1,7 +1,6 @@ --- title: GCP --- -# GCP
diff --git a/how-to-guides/cloud-services/gcp/connecting-to-bigquery.md b/how-to-guides/cloud-services/gcp/connecting-to-bigquery.md index 28ff07d..eb2764f 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-bigquery.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-bigquery.md @@ -1,7 +1,6 @@ --- title: BigQuery --- -# BigQuery Connecting to GCP BigQuery Service from your DevBox. @@ -27,34 +26,27 @@ Connecting to GCP BigQuery Service from your DevBox. 2. Store the **Google Authentication Credentials** on the workspace. 3. Install **Python** and **PIP**: -{% code lineNumbers="false" %} ``` sudo apt update sudo apt install python3 python3-dev python3-venv sudo apt-get install wget wget https://bootstrap.pypa.io/get-pip.py ``` -{% endcode %} 4. Install **BigQuery API**: -{% code lineNumbers="false" %} ``` pip install google-cloud-bigquery ``` -{% endcode %} 5. Set the **GOOGLE_APPLICATION_CREDENTIALS** environment variable. -{% code lineNumbers="false" %} ``` export GOOGLE_APPLICATION_CREDENTIALS=/path/to/the/key.json ``` -{% endcode %} 6. Write a Python scipt to test the BigQuery API Connection: -{% code lineNumbers="false" %} ```python from google.cloud import bigquery @@ -65,15 +57,12 @@ if client: else: print("Connection failed") ``` -{% endcode %} 7. Run the Python Script: -{% code lineNumbers="false" %} ``` python3 .py ``` -{% endcode %} If the connection is successful, you should see **"Connected"** printed in the terminal output. diff --git a/how-to-guides/cloud-services/gcp/connecting-to-cloud-sql.md b/how-to-guides/cloud-services/gcp/connecting-to-cloud-sql.md index 9433320..2729431 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-cloud-sql.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-cloud-sql.md @@ -1,7 +1,6 @@ --- title: Cloud SQL --- -# Cloud SQL Connecting to an Cloud SQL running in the private subnet of GCP VPC to your DevBox. @@ -28,11 +27,9 @@ Connecting to an Cloud SQL running in the private subnet of GCP VPC to your DevB 4. SSH into your **Bastion Host** and enter the following command: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo dz net connect --ssh --advertise-routes= ``` -{% endcode %} 5. Go to **DevBox**. 6. Connecting to the Database. @@ -49,11 +46,10 @@ sudo apt install mysql-client To access the database: -{% code %} ``` mysql -h -u --database -p ``` -{% endcode %} + {% endtab %} {% tab title="PostgreSQL" %} @@ -65,11 +61,10 @@ sudo apt install postgresql-client To access the database: -{% code %} ``` psql -h --username -d --password ``` -{% endcode %} + {% endtab %} {% endtabs %} @@ -101,11 +96,9 @@ psql -h --username -d --password 4. SSH into your **Bastion Host** and enter the following command: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo dz net connect --ssh --advertise-routes= ``` -{% endcode %} 5. Go to **DevBox**. 6. Connecting to the Database. @@ -122,11 +115,10 @@ sudo apt install mysql-client To access the database: -{% code %} ``` mysql -h -u --database -p ``` -{% endcode %} + {% endtab %} {% tab title="PostgreSQL" %} @@ -138,11 +130,10 @@ sudo apt install postgresql-client To access the database: -{% code %} ``` psql -h --username -d --password ``` -{% endcode %} + {% endtab %} {% endtabs %} diff --git a/how-to-guides/cloud-services/gcp/connecting-to-cloud-storage.md b/how-to-guides/cloud-services/gcp/connecting-to-cloud-storage.md index ddf74d2..888c467 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-cloud-storage.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-cloud-storage.md @@ -1,7 +1,6 @@ --- title: Cloud Storage --- -# Cloud Storage Connecting to GCP Cloud Storage Service from your DevBox. @@ -15,29 +14,23 @@ Connecting to GCP Cloud Storage Service from your DevBox. 1. Go to your **DevBox** and install Gcloud SDK: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo apt-get update sudo apt-get install apt-transport-https ca-certificates gnupg curl sudo apt-get update && sudo apt-get install google-cloud-cli ``` -{% endcode %} 2. Authenticate your GCP account with Gcloud SDK: -{% code overflow="wrap" lineNumbers="false" %} ``` gcloud init ``` -{% endcode %} 3. Access your cloud storage list by: -{% code overflow="wrap" lineNumbers="false" %} ``` gsutil ls gs:// ``` -{% endcode %} ![image](../../../.gitbook/assets/gcp-cloudstorage-access.png) @@ -55,28 +48,22 @@ gsutil ls gs:// 1. Go to your **DevBox** and install Gcloud SDK: -{% code overflow="wrap" lineNumbers="false" %} ``` sudo apt-get update sudo apt-get install apt-transport-https ca-certificates gnupg curl sudo apt-get update && sudo apt-get install google-cloud-cli ``` -{% endcode %} 2. Authenticate your GCP account with Gcloud SDK: -{% code overflow="wrap" lineNumbers="false" %} ``` gcloud init ``` -{% endcode %} 3. Access your cloud storage list by: -{% code overflow="wrap" lineNumbers="false" %} ``` gsutil ls gs:// ``` -{% endcode %} ![image](../../../.gitbook/assets/gcp-cloudstorage-access.png) diff --git a/how-to-guides/cloud-services/gcp/connecting-to-cloudrun.md b/how-to-guides/cloud-services/gcp/connecting-to-cloudrun.md index 47f5a21..e048ad8 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-cloudrun.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-cloudrun.md @@ -1,7 +1,6 @@ --- title: Cloud Run --- -# Cloud Run Connecting to GCP Cloud Run Service from your DevBox. @@ -25,7 +24,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -41,7 +39,6 @@ build: echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list sudo apt-get update && sudo apt-get install google-cloud-cli ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -56,11 +53,9 @@ build: Now, this is where the real task begins. After downloading the `gcloud` package, we must authenticate with our Google Cloud account. To do this, we need to run the simple command. -{% code overflow="wrap" lineNumbers="false" %} ``` gcloud init ``` -{% endcode %} After running the command, you will be given various options for choosing your **Google account**, default **Project**, and default **Compute Region and Zone**. You can choose what you prefer. @@ -72,27 +67,21 @@ Follow the below steps to generate the Authentication token and access the Cloud 1. Use the below command to get the token: -{% code overflow="wrap" lineNumbers="false" %} ``` gcloud auth print-identity-token ``` -{% endcode %} 2. Export the token to an environmental variable: -{% code overflow="wrap" lineNumbers="false" %} ``` export TOKEN=$(gcloud auth print-identity-token) ``` -{% endcode %} 3. Now that everything is set, we can finally finish this all off by accessing the applications with the `curl` command: -{% code overflow="wrap" lineNumbers="false" %} ``` curl -H "Authorization: Bearer ${TOKEN}" ``` -{% endcode %} ![GCP Cloud Run Container Access](../../../.gitbook/assets/gcp-cloudrun-access.png) @@ -105,9 +94,7 @@ If you want to create a new Cloud Run Container, you can follow the below steps. 1. Go to **Cloud Run > Services** and click **Deploy Container**. 2. Choose a deployment method between **Deploy one revision from an existing container image**, **Continuously deploy from a repository (source or function)**. -{% hint style="info" %} -We are creating a container with an existing demo image for this guide. -{% endhint %} +> We are creating a container with an existing demo image for this guide. {% tabs %} {% tab title="Existing Image"%} @@ -133,7 +120,6 @@ First, we need to create a recipe for the workspace: 2. Enter the recipe name and click on **Create a recipe**. 3. Now use the below-provided snippet to create a recipe for your workspace: -{% code lineNumbers="false" %} ``` version: "3" @@ -149,7 +135,6 @@ build: echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list sudo apt-get update && sudo apt-get install google-cloud-cli ``` -{% endcode %} 4. Click on **Save and Build** and when the build is successful, click on **Publish**. @@ -164,11 +149,9 @@ build: Now, this is where the real task begins. After downloading the `gcloud` package, we must authenticate with our Google Cloud account. To do this, we need to run the simple command. -{% code overflow="wrap" lineNumbers="false" %} ``` gcloud init ``` -{% endcode %} After running the command, you will be given various options for choosing your **Google account**, default **Project**, and default **Compute Region and Zone**. You can choose what you prefer. @@ -180,26 +163,20 @@ Follow the below steps to generate the Authentication token and access the Cloud 1. Use the below command to get the token: -{% code overflow="wrap" lineNumbers="false" %} ``` gcloud auth print-identity-token ``` -{% endcode %} 2. Export the token to an environmental variable: -{% code overflow="wrap" lineNumbers="false" %} ``` export TOKEN=$(gcloud auth print-identity-token) ``` -{% endcode %} 3. Now that everything is set, we can finally finish this all off by accessing the applications with the `curl` command: -{% code overflow="wrap" lineNumbers="false" %} ``` curl -H "Authorization: Bearer ${TOKEN}" ``` -{% endcode %} ![GCP Cloud Run Container Access](../../../.gitbook/assets/gcp-cloudrun-access.png) diff --git a/how-to-guides/cloud-services/gcp/connecting-to-compute-instance.md b/how-to-guides/cloud-services/gcp/connecting-to-compute-instance.md index c5132d3..8496e44 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-compute-instance.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-compute-instance.md @@ -1,7 +1,6 @@ --- title: GCP Compute Instance --- -# GCP Compute Instance Connecting to Compute Instance running in the private subnet of GCP VPC from your DevBox. @@ -22,11 +21,9 @@ Follow [Connecting to GCP](../../existing-network/connecting-to-gcp.md) guide. 3. Go to **DevBox** and make a copy of the key pair. 4. Connect to Compute Instance: -{% code lineNumbers="false" %} ``` ssh -i "path/to/private/key" username@instance-ip ``` -{% endcode %} ![GCP Compute Instance Access](../../../.gitbook/assets/compute-instance-access.png) @@ -47,10 +44,8 @@ ssh -i "path/to/private/key" username@instance-ip 1. Go to the **DevBox** and make a copy of the key pair. 2. Connect to the desired Compute instance using ssh and the new key pair: -{% code lineNumbers="false" %} ``` ssh -i "path/to/private/key" username@instance-ip ``` -{% endcode %} ![GCP Compute Instance Access](../../../.gitbook/assets/compute-instance-access.png) diff --git a/how-to-guides/cloud-services/gcp/connecting-to-firestore-datastore.md b/how-to-guides/cloud-services/gcp/connecting-to-firestore-datastore.md index 84d1dfe..5cf309d 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-firestore-datastore.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-firestore-datastore.md @@ -1,7 +1,6 @@ --- title: GCP Firestore (Datastore Mode) --- -# GCP Firestore (Datastore Mode) Connecting to an Firestore instance to your DevBox. @@ -21,34 +20,27 @@ Connecting to an Firestore instance to your DevBox. 2. Store the **Google Authentication Credentials** on the workspace. 3. Install **Python** and **PIP**: -{% code lineNumbers="false" %} ``` sudo apt update sudo apt install python3 python3-dev python3-venv sudo apt-get install wget wget https://bootstrap.pypa.io/get-pip.py ``` -{% endcode %} 4. Install **Firestore Admin API**: -{% code lineNumbers="false" %} ``` pip install --upgrade google-cloud-datastore ``` -{% endcode %} 5. Set the **GOOGLE_APPLICATION_CREDENTIALS** environment variable. -{% code lineNumbers="false" %} ``` export GOOGLE_APPLICATION_CREDENTIALS=/path/to/the/key.json ``` -{% endcode %} 6. Write a Python scipt to test the Firestore Admin API Connection: -{% code lineNumbers="false" %} ```python from google.cloud import datastore @@ -59,15 +51,12 @@ if datastore_client: else: pass ``` -{% endcode %} 7. Run the Python Script: -{% code lineNumbers="false" %} ``` python3 .py ``` -{% endcode %} If the connection is successful, you should see **"Connected"** printed in the terminal output. @@ -90,34 +79,27 @@ If the connection is successful, you should see **"Connected"** printed in the t 2. Store the **Google Authentication Credentials** on the workspace. 3. Install **Python** and **PIP**: -{% code lineNumbers="false" %} ``` sudo apt update sudo apt install python3 python3-dev python3-venv sudo apt-get install wget wget https://bootstrap.pypa.io/get-pip.py ``` -{% endcode %} 4. Install **Firestore Admin API**: -{% code lineNumbers="false" %} ``` pip install --upgrade google-cloud-datastore ``` -{% endcode %} 5. Set the **GOOGLE_APPLICATION_CREDENTIALS** environment variable. -{% code lineNumbers="false" %} ``` export GOOGLE_APPLICATION_CREDENTIALS=/path/to/the/key.json ``` -{% endcode %} 6. Write a Python scipt to test the Firestore Admin API Connection: -{% code lineNumbers="false" %} ```python from google.cloud import datastore @@ -128,15 +110,12 @@ if datastore_client: else: pass ``` -{% endcode %} 7. Run the Python Script: -{% code lineNumbers="false" %} ``` python3 .py ``` -{% endcode %} If the connection is successful, you should see **"Connected"** printed in the terminal output. diff --git a/how-to-guides/cloud-services/gcp/connecting-to-firestore-native.md b/how-to-guides/cloud-services/gcp/connecting-to-firestore-native.md index 57d7a18..904d626 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-firestore-native.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-firestore-native.md @@ -1,7 +1,6 @@ --- title: GCP Firestore (Native Mode) --- -# GCP Firestore (Native Mode) Connecting to an Firestore instance to your DevBox. @@ -21,34 +20,27 @@ Connecting to an Firestore instance to your DevBox. 2. Store the **Google Authentication Credentials** on the workspace. 3. Install **Python** and **PIP**: -{% code lineNumbers="false" %} ``` sudo apt update sudo apt install python3 python3-dev python3-venv sudo apt-get install wget wget https://bootstrap.pypa.io/get-pip.py ``` -{% endcode %} 4. Install **Firestore Admin API**: -{% code lineNumbers="false" %} ``` pip install --upgrade firebase-admin ``` -{% endcode %} 5. Set the **GOOGLE_APPLICATION_CREDENTIALS** environment variable. -{% code lineNumbers="false" %} ``` export GOOGLE_APPLICATION_CREDENTIALS=/path/to/the/key.json ``` -{% endcode %} 6. Write a Python scipt to test the Firestore Admin API Connection: -{% code lineNumbers="false" %} ```python import firebase_admin from firebase_admin import credentials, firestore @@ -60,15 +52,12 @@ if db: else: pass ``` -{% endcode %} 7. Run the Python Script: -{% code lineNumbers="false" %} ``` python3 .py ``` -{% endcode %} If the connection is successful, you should see **"Connected"** printed in the terminal output. @@ -91,34 +80,27 @@ If the connection is successful, you should see **"Connected"** printed in the t 2. Store the **Google Authentication Credentials** on the workspace. 3. Install **Python** and **PIP**: -{% code lineNumbers="false" %} ``` sudo apt update sudo apt install python3 python3-dev python3-venv sudo apt-get install wget wget https://bootstrap.pypa.io/get-pip.py ``` -{% endcode %} 4. Install **Firestore Admin API**: -{% code lineNumbers="false" %} ``` pip install --upgrade firebase-admin ``` -{% endcode %} 5. Set the **GOOGLE_APPLICATION_CREDENTIALS** environment variable. -{% code lineNumbers="false" %} ``` export GOOGLE_APPLICATION_CREDENTIALS=/path/to/the/key.json ``` -{% endcode %} 6. Write a Python scipt to test the Firestore Admin API Connection: -{% code lineNumbers="false" %} ```python import firebase_admin from firebase_admin import credentials, firestore @@ -130,15 +112,12 @@ if db: else: pass ``` -{% endcode %} 7. Run the Python Script: -{% code lineNumbers="false" %} ``` python3 .py ``` -{% endcode %} If the connection is successful, you should see **"Connected"** printed in the terminal output. diff --git a/how-to-guides/cloud-services/gcp/connecting-to-kubernetes-cluster.md b/how-to-guides/cloud-services/gcp/connecting-to-kubernetes-cluster.md index 4c9ef0a..5bb9d78 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-kubernetes-cluster.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-kubernetes-cluster.md @@ -1,7 +1,6 @@ --- title: GCP Kubernetes Engine --- -# GCP Kubernetes Engine Connecting to GCP Kubernetes Cluster running in the private subnet of GCP VPC from your DevBox. @@ -19,53 +18,41 @@ Connecting to GCP Kubernetes Cluster running in the private subnet of GCP VPC fr 1. Go to your **DevBox** and install Gcloud SDK: -{% code lineNumbers="false" %} ``` sudo apt-get update sudo apt-get install apt-transport-https ca-certificates gnupg curl sudo apt-get update && sudo apt-get install google-cloud-cli ``` -{% endcode %} 2. Authenticate your GCP account with Gcloud SDK: -{% code lineNumbers="false" %} ``` gcloud init ``` -{% endcode %} 3. Download the **kubectl** binaries: -{% code lineNumbers="false" %} ``` curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" ``` -{% endcode %} 4. Install **kubectl**: -{% code lineNumbers="false" %} ``` sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` -{% endcode %} 5. Connect to the cluster: -{% code lineNumbers="false" %} ``` gcloud container clusters get-credentials --zone --project ``` -{% endcode %} 6. Check if the cluster is accessible: -{% code lineNumbers="false" %} ``` kubectl get svc ``` -{% endcode %} ![GCP GKE -> Devbox](../../../.gitbook/assets/gcp-gke-devbox-access.png) @@ -93,54 +80,42 @@ kubectl get svc 1. Go to your **DevBox** and install Gcloud SDK: -{% code lineNumbers="false" %} ``` sudo apt-get update sudo apt-get install apt-transport-https ca-certificates gnupg curl sudo apt-get update && sudo apt-get install google-cloud-cli ``` -{% endcode %} 2. Authenticate your GCP account with Gcloud SDK: -{% code lineNumbers="false" %} ``` gcloud init ``` -{% endcode %} 3. Download **kubectl** binaries: -{% code lineNumbers="false" %} ``` curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" ``` -{% endcode %} 4. Install **kubectl**: -{% code lineNumbers="false" %} ``` sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` -{% endcode %} ### Step 3: Accessing the GKE Cluster 1. Connect to the cluster: -{% code lineNumbers="false" %} ``` gcloud container clusters get-credentials --zone --project ``` -{% endcode %} 2. Check if the cluster is accessible: -{% code %} ``` kubectl get svc ``` -{% endcode %} ![GCP GKE -> Devbox](../../../.gitbook/assets/gcp-gke-devbox-access.png) diff --git a/how-to-guides/cloud-services/gcp/connecting-to-memorystore.md b/how-to-guides/cloud-services/gcp/connecting-to-memorystore.md index dfef797..1ed6e5f 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-memorystore.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-memorystore.md @@ -1,7 +1,6 @@ --- title: Memorystore --- -# Memorystore Connecting to Memorystore running in the private subnet of GCP VPC from your DevBox. @@ -24,11 +23,9 @@ Connecting to Memorystore running in the private subnet of GCP VPC from your Dev 3. Go to your **DevBox** and connect to Service: -{% code lineNumbers="false" %} ``` telnet 6379 ``` -{% endcode %} ![image](../../../.gitbook/assets/gcp-memorystore-access.png) @@ -55,10 +52,8 @@ telnet 6379 3. Go to your **DevBox** and connect to Service: -{% code lineNumbers="false" %} ``` telnet 6379 ``` -{% endcode %} ![image](../../../.gitbook/assets/gcp-memorystore-access.png) diff --git a/how-to-guides/cloud-services/gcp/connecting-to-secret-manager.md b/how-to-guides/cloud-services/gcp/connecting-to-secret-manager.md index 0b0f61f..05d8841 100644 --- a/how-to-guides/cloud-services/gcp/connecting-to-secret-manager.md +++ b/how-to-guides/cloud-services/gcp/connecting-to-secret-manager.md @@ -1,7 +1,6 @@ --- title: GCP Secret Manager --- -# GCP Secret Manager You are connecting to a GCP Secret Manager from your DevBox. @@ -34,34 +33,27 @@ Now, to retrieve the value from the secrets using the API, you need to authentic 1. Go to **DevBox** and store the **Google Authentication Credentials** on the workspace. 2. Install **Python** and **PIP**: -{% code lineNumbers="false" %} ``` sudo apt update sudo apt install python3 python3-dev python3-venv sudo apt-get install wget wget https://bootstrap.pypa.io/get-pip.py ``` -{% endcode %} 3. Install **Secret Manager API**: -{% code lineNumbers="false" %} ``` pip install google-cloud-secret-manager ``` -{% endcode %} 4. Set the **GOOGLE_APPLICATION_CREDENTIALS** environment variable by using the following command: -{% code lineNumbers="false" %} ``` export GOOGLE_APPLICATION_CREDENTIALS=/path/to/the/key.json ``` -{% endcode %} 5. Write a Python script to test the Secret Manager API Connection: -{% code lineNumbers="false" %} ``` from google.cloud import secretmanager @@ -77,15 +69,12 @@ def access_secret_version(project_id, secret_id, version_id): access_secret_version('', '') ``` -{% endcode %} 7. Run the Python Script: -{% code lineNumbers="false" %} ``` python3 .py ``` -{% endcode %} If the connection is successful, you should see **Secret** printed in the terminal output. @@ -122,34 +111,27 @@ Now, to retrieve the value from the secrets using the API, you need to authentic 1. Go to **DevBox** and store the **Google Authentication Credentials** in the workspace. 2. Install **Python** and **Pip**: -{% code lineNumbers="false" %} ``` sudo apt update sudo apt install python3 python3-dev python3-venv sudo apt-get install wget wget https://bootstrap.pypa.io/get-pip.py ``` -{% endcode %} 3. Install **Secret Manager** package: -{% code lineNumbers="false" %} ``` pip install google-cloud-secret-manager ``` -{% endcode %} 4. Set the **GOOGLE_APPLICATION_CREDENTIALS** environment variable by using the following command: -{% code lineNumbers="false" %} ``` export GOOGLE_APPLICATION_CREDENTIALS=/path/to/the/key.json ``` -{% endcode %} 5. Write a Python script to test the Secret Manager API Connection: -{% code lineNumbers="false" %} ``` from google.cloud import secretmanager @@ -165,15 +147,12 @@ def access_secret_version(project_id, secret_id, version_id): access_secret_version('', '') ``` -{% endcode %} 7. Run the Python Script: -{% code lineNumbers="false" %} ``` python3 .py ``` -{% endcode %} If the connection is successful, you should see **Secret** printed in the terminal output. diff --git a/how-to-guides/databases/README.md b/how-to-guides/databases/README.md index b84a3dc..1f784ba 100644 --- a/how-to-guides/databases/README.md +++ b/how-to-guides/databases/README.md @@ -1,7 +1,6 @@ ---- -title: Databases ---- -# Databases +--- +title: Databases +---
diff --git a/how-to-guides/databases/mongodb.md b/how-to-guides/databases/mongodb.md index 430b4d5..9eb39a8 100644 --- a/how-to-guides/databases/mongodb.md +++ b/how-to-guides/databases/mongodb.md @@ -1,7 +1,6 @@ --- title: MongoDB Atlas --- -# MongoDB Atlas Comprehensive guide for connecting to a MongoDB Cluster from your DevBox. @@ -15,9 +14,7 @@ This would be done by setting up the cluster in your Atlas dashboard through one Before you begin, create your account with [MongoDB](https://account.mongodb.com/account/login). -{% hint style="info" %} -MongoDB only supports Private Endpoint access for **Dedicated** or **Serverless** clusters. Private Endpoint access for the **Shared** cluster is not yet supported. -{% endhint %} +> MongoDB only supports Private Endpoint access for **Dedicated** or **Serverless** clusters. Private Endpoint access for the **Shared** cluster is not yet supported. ## Existing MongoDB Cluster @@ -34,9 +31,7 @@ To check and configure the same, follow the below steps: 2. Go to **Security > Network Access** and open the **Private Endpoint** tab. 3. Click on **Add Private Endpoint** and choose your cloud provider. For this tutorial, we will be using Azure. -{% hint style="info" %} -You must provide the billing information in the Edit Payment Method form if you still need to get the payment method configured for your organization. -{% endhint %} +> You must provide the billing information in the Edit Payment Method form if you still need to get the payment method configured for your organization. 4. Click on **Next** and choose the **Region** where you want to deploy your endpoint. 5. Enter your **Resource Group Name**, **Virtual Network Name**, **Subnet Name**, and the name you want to give to your endpoint. @@ -57,46 +52,36 @@ Follow the below steps to do so: 1. Install `gnupg` and `curl` if they are not already: -{% code %} ``` sudo apt-get install gnupg curl ``` -{% endcode %} 2. Get the **MongoDB public GPG key**: -{% code %} ``` curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \ --dearmor ``` -{% endcode %} 3. Create a list file for MongoDB: -{% code %} ``` echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list sudo apt-get update ``` -{% endcode %} 4. Install the MongoDB Package: -{% code %} ``` sudo apt-get install -y mongodb-org ``` -{% endcode %} 5. verify if `mongosh` is installed or not: -{% code %} ``` mongosh ``` -{% endcode %} ### Step 3: Connecting to the Cluster @@ -107,11 +92,9 @@ To connect to the MongoDB cluster, follow the below steps: 3. Click on **Connect** and choose the private endpoint option. 4. Then Click on **Shell**, copy the connection string, and paste it into your DevBox: -{% code %} ``` mongosh "mongodb+srv://..mongodb.net/" --apiVersion 1 --username ``` -{% endcode %} 5. Enter the password when prompted, and you will see the MongoDB cluster is connected. @@ -141,51 +124,39 @@ Follow the below steps to do so: 1. Install `gnupg` and `curl` if they are not already: -{% code %} ``` sudo apt-get install gnupg curl ``` -{% endcode %} 2. Get the **MongoDB public GPG key**: -{% code %} ``` curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \ --dearmor ``` -{% endcode %} 3. Create a list file for MongoDB: -{% code %} ``` echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list ``` -{% endcode %} 4. Install the MongoDB Package: -{% code %} ``` sudo apt-get install -y mongodb-org ``` -{% endcode %} 5. verify if `mongosh` is installed or not: -{% code %} ``` mongosh ``` -{% endcode %} ### Step 3: Creating a X.509 Certificate (OPTIONAL) -{% hint style="info" %} -You can skip this step if you prefer to use password-based authentication. We are using an X.509 certificate authentication to add an extra layer of security because a shared type cluster allows all internet traffic, which also requires code changes. -{% endhint %} +> You can skip this step if you prefer to use password-based authentication. We are using an X.509 certificate authentication to add an extra layer of security because a shared type cluster allows all internet traffic, which also requires code changes. To add a layer of security, we will authenticate it with an X.509 certificate. You may follow the below steps to do so: @@ -208,21 +179,19 @@ To connect to the MongoDB cluster, follow the below steps: {% tab title="Password" %} 4. Choose the **Password (SCRAM)** option and copy the connection string and paste it into your DevBox CLI: -{% code %} ``` mongosh "mongodb+srv://..mongodb.net/" --apiVersion 1 --username ``` -{% endcode %} + {% endtab %} {% tab title="X.509" %} 4. Choose the **X.509** Certificate option and copy the connection string and paste it into your DevBox CLI: -{% code %} ``` mongosh "mongodb+srv://..mongodb.net/?authSource=%24external&authMechanism=MONGODB-X509" --apiVersion 1 --tls --tlsCertificateKeyFile /path/to/certificate.pem ``` -{% endcode %} + {% endtab %} {% endtabs %} @@ -250,9 +219,7 @@ If you need to make a new database cluster and access it through DevBox, then fo 6. Go to **Security > Network Access** and open the **Private Endpoint** tab. 7. Click on **Add Private Endpoint** and choose your cloud provider. For this tutorial, we will be using Azure. -{% hint style="info" %} -You must provide the billing information in the Edit Payment Method form if you don't have a payment method already configured for your organization. -{% endhint %} +> You must provide the billing information in the Edit Payment Method form if you don't have a payment method already configured for your organization. 8. Click on **Next** and choose the **Region** where you want to deploy your endpoint. 9. Enter your **Resource Group Name**, **Virtual Network Name**, **Subnet Name**, and the name you want to give to your endpoint. @@ -273,45 +240,35 @@ Follow the below steps to do so: 1. Install `gnupg` and `curl` if they are not already: -{% code %} ``` sudo apt-get install gnupg curl ``` -{% endcode %} 2. Get the **MongoDB public GPG key**: -{% code %} ``` curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \ --dearmor ``` -{% endcode %} 3. Create a list file for MongoDB: -{% code %} ``` echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list ``` -{% endcode %} 4. Install the MongoDB Package: -{% code %} ``` sudo apt-get install -y mongodb-org ``` -{% endcode %} 5. verify if `mongosh` is installed or not: -{% code %} ```bash mongosh ``` -{% endcode %} ### Step 3: Connecting with the Cluster @@ -322,11 +279,9 @@ To connect to the MongoDB cluster, follow the below steps: 3. Click on **Connect** and choose the private endpoint option. 4. Then Click on **Shell**, copy the connection string, and paste it into your DevBox CLI: -{% code %} ```bash mongosh "mongodb+srv://..mongodb.net/" --apiVersion 1 --username ``` -{% endcode %} 5. Enter the password when prompted, and you will see the mongosh shell if the connection is authenticated. @@ -356,51 +311,39 @@ Follow the below steps to do so: 1. Install `gnupg` and `curl` if they are not already: -{% code %} ``` sudo apt-get install gnupg curl ``` -{% endcode %} 2. Get the **MongoDB public GPG key**: -{% code %} ``` curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \ --dearmor ``` -{% endcode %} 3. Create a list file for MongoDB: -{% code %} ``` echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list ``` -{% endcode %} 4. Install the MongoDB Package: -{% code %} ``` sudo apt-get install -y mongodb-org ``` -{% endcode %} 5. verify if `mongosh` is installed or not: -{% code %} ``` mongosh ``` -{% endcode %} ### Step 3: Creating an X.509 Certificate (OPTIONAL) -{% hint style="info" %} -You can skip this step if you prefer to use password-based authentication. We are using an X.509 certificate authentication to add an extra layer of security because a shared type cluster allows all internet traffic, which also requires code changes. -{% endhint %} +> You can skip this step if you prefer to use password-based authentication. We are using an X.509 certificate authentication to add an extra layer of security because a shared type cluster allows all internet traffic, which also requires code changes. To add a layer of security, we will authenticate it with an X.509 certificate. You may follow the below steps to do so: @@ -423,21 +366,19 @@ To connect to the MongoDB cluster, follow the below steps: {% tab title="Password" %} 4. Choose the **Password (SCRAM)** option and copy the connection string and paste it into your DevBox CLI: -{% code %} ``` mongosh "mongodb+srv://..mongodb.net/" --apiVersion 1 --username ``` -{% endcode %} + {% endtab %} {% tab title="X.509" %} 4. Choose the **X.509** Certificate option and copy the connection string and paste it into your DevBox CLI: -{% code %} ``` mongosh "mongodb+srv://..mongodb.net/?authSource=%24external&authMechanism=MONGODB-X509" --apiVersion 1 --tls --tlsCertificateKeyFile /path/to/certificate.pem ``` -{% endcode %} + {% endtab %} {% endtabs %} diff --git a/how-to-guides/databases/neon-db.md b/how-to-guides/databases/neon-db.md index 66b5e7e..d715194 100644 --- a/how-to-guides/databases/neon-db.md +++ b/how-to-guides/databases/neon-db.md @@ -3,7 +3,6 @@ description: Using a NeonDB database branch from a DevZero workspace. title: Neon --- -# Neon ## Architecture Diagram @@ -130,4 +129,4 @@ Now that we have a working recipe, we can create a workspace off it from the [re ### Video Walkthrough -{% embed url="https://vimeo.com/1001281574?share=copy" %} +[![Video Walkthrough](https://vimeo.com/1001281574?share=copy)](https://vimeo.com/1001281574?share=copy) diff --git a/how-to-guides/databases/planetscale.md b/how-to-guides/databases/planetscale.md index 9f427df..02f4eb4 100644 --- a/how-to-guides/databases/planetscale.md +++ b/how-to-guides/databases/planetscale.md @@ -1,7 +1,6 @@ --- title: PlanetScale --- -# PlanetScale Comprehensive guide for connecting to a PlanetScale Database from your DevBox. @@ -39,7 +38,6 @@ You will need to create a Recipe in DevZero equipped with the necessary tools li 3. Click on **Create a recipe**, and your recipe will be created. 4. Replace the recipe yaml file with the snippet below. Remember to replace the placeholder username and password with the value you noted down in the above steps: -{% code %} ``` version: "3" @@ -55,7 +53,6 @@ runtime: - name: DATABASE_PASSWORD value: ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -73,12 +70,10 @@ Now, with everything set, you just need to use the connection string to access t 1. Go to DevBox. 2. Use the following command to connect to the database: -{% code %} ``` mysql -h aws.connect.psdb.cloud -D -u $DATABASE_USERNAME -p$DATABASE_PASSWORD --ssl-mode=VERIFY_IDENTITY --ssl-ca=/etc/ssl/certs/ca-certificates.crt ``` -{% endcode %} ![PlanetScale database access](../../.gitbook/assets/planetscale-access.png) @@ -107,7 +102,6 @@ You will need to create a Recipe in DevZero equipped with the necessary tools li 3. Click on **Create a recipe**, and your recipe will be created. 4. Replace the recipe yaml file with the snippet below. Remember to replace the placeholder username and password with the value you noted down in the above steps: -{% code %} ``` version: "3" @@ -123,7 +117,6 @@ runtime: - name: DATABASE_PASSWORD value: ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -141,15 +134,13 @@ Now, with everything set, you just need to use the connection string to access t 1. Go to DevBox. 2. Use the following command to connect to the database: -{% code %} ``` mysql -h aws.connect.psdb.cloud -D -u $DATABASE_USERNAME -p$DATABASE_PASSWORD --ssl-mode=VERIFY_IDENTITY --ssl-ca=/etc/ssl/certs/ca-certificates.crt ``` -{% endcode %} ![PlanetScale database access](../../.gitbook/assets/planetscale-access.png) ## Video Walkthrough -{% embed url="https://devzero.b-cdn.net/how%20to%20guide%20Planetscale%20Database.mov" %} +[![Video Walkthrough](https://devzero.b-cdn.net/how%20to%20guide%20Planetscale%20Database.mov)](https://devzero.b-cdn.net/how%20to%20guide%20Planetscale%20Database.mov) diff --git a/how-to-guides/databases/supabase.md b/how-to-guides/databases/supabase.md index deb8bba..1f2e181 100644 --- a/how-to-guides/databases/supabase.md +++ b/how-to-guides/databases/supabase.md @@ -1,7 +1,6 @@ --- title: Supabase --- -# Supabase Comprehensive guide for connecting to a Supabase Project from your DevBox. @@ -27,19 +26,15 @@ Follow the below steps to do so: 1. Use the following command to reload the local package database: -{% code %} ``` sudo apt-get update ``` -{% endcode %} 2. Install the PostgresSQL : -{% code %} ``` sudo apt install postgresql-client ``` -{% endcode %} ![Postgres client install](../../.gitbook/assets/supabase-install.png) @@ -78,19 +73,15 @@ Follow the below steps to do so: 1. Use the following command to reload the local package database: -{% code %} ``` sudo apt-get update ``` -{% endcode %} 2. Install the PostgresSQL : -{% code %} ``` sudo apt install postgresql-client ``` -{% endcode %} ![Postgres client install](../../.gitbook/assets/supabase-install.png) @@ -110,4 +101,4 @@ To make the connection, follow the below steps: ## Video Walkthrough -{% embed url="https://devzero.b-cdn.net/How%20to%20Connect%20Supabase%20to%20Your%20Dev%20Box-inline-subtitles.mp4" %} +[![Video Walkthrough](https://devzero.b-cdn.net/How%20to%20Connect%20Supabase%20to%20Your%20Dev%20Box-inline-subtitles.mp4)](https://devzero.b-cdn.net/How%20to%20Connect%20Supabase%20to%20Your%20Dev%20Box-inline-subtitles.mp4) diff --git a/how-to-guides/databases/timescale.md b/how-to-guides/databases/timescale.md index b9f4e0b..bb30b99 100644 --- a/how-to-guides/databases/timescale.md +++ b/how-to-guides/databases/timescale.md @@ -1,7 +1,6 @@ --- title: Timescale --- -# Timescale Comprehensive guide for connecting to a Timescale Database from your DevBox. @@ -27,7 +26,6 @@ You will need to create a Recipe in DevZero equipped with the necessary tools li 3. Click on **Create a recipe**, and your recipe will be created. 4. Replace the recipe yaml file with the snippet below: -{% code %} ``` version: "3" @@ -36,7 +34,6 @@ build: - type: apt-get packages: ["build-essential", "curl", "git", "nano", "software-properties-common", "ssh", "sudo", "tar", "unzip", "vim", "wget", "zip", "postgresql-client"] ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -80,11 +77,9 @@ Now, with everything set, you just need to use the connection string to access t 4. Go to DevBox, paste the connection string, and enter the password when prompted: -{% code %} ``` psql "postgres://@..cloud.timescale.com:30035/?sslmode=require" ``` -{% endcode %} ![Timescale database access](../../.gitbook/assets/timescale-access.png) @@ -122,7 +117,6 @@ You will need to create a Recipe in DevZero equipped with the necessary tools li 3. Click on **Create a recipe**, and your recipe will be created. 4. Replace the recipe yaml file with the snippet below: -{% code %} ``` version: "3" @@ -131,7 +125,6 @@ build: - type: apt-get packages: ["build-essential", "curl", "git", "nano", "software-properties-common", "ssh", "sudo", "tar", "unzip", "vim", "wget", "zip", "postgresql-client"] ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -154,10 +147,8 @@ Now, with everything set, you just need to use the connection string to access t 4. Go to DevBox, paste the connection string, and enter the password when prompted. -{% code %} ``` psql "postgres://@..cloud.timescale.com:30035/?sslmode=require" ``` -{% endcode %} ![Timescale database access](../../.gitbook/assets/timescale-access.png) diff --git a/how-to-guides/databases/xata.md b/how-to-guides/databases/xata.md index 17d9eca..ca32bb7 100644 --- a/how-to-guides/databases/xata.md +++ b/how-to-guides/databases/xata.md @@ -1,7 +1,6 @@ --- title: Xata --- -# Xata Comprehensive guide for connecting to Xata Workspace Database from your DevBox. @@ -40,7 +39,6 @@ You will need to create a Recipe in DevZero equipped with the necessary tools li 3. Click on **Create a recipe**, and your recipe will be created. 4. Replace the recipe `yaml` file with the snippet below. Remember to replace the placeholder API key with the key you noted down in the above steps: -{% code %} ``` version: "3" @@ -54,7 +52,6 @@ runtime: - name: XATA_API_KEY value: ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -76,11 +73,9 @@ Follow the below steps to connect to the database instance: 3. Copy the connection string for **PostgreSQL endpoint** and then use the following command to connect to the Database: -{% code %} ``` psql postgresql://:$XATA_API_KEY@.sql.xata.sh/:?sslmode=require ``` -{% endcode %} ![Xata Database Access](../../.gitbook/assets/xata-db-access.png) @@ -114,7 +109,6 @@ You will need to create a **Recipe** in DevZero equipped with the necessary tool 3. Click on **Create a recipe**, and your recipe will be created. 4. Replace the recipe `yaml` file with the snippet below. Remember to replace the placeholder API key with the Key you noted down in the above steps: -{% code %} ``` version: "3" @@ -128,7 +122,6 @@ runtime: - name: XATA_API_KEY value: ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -150,11 +143,9 @@ Follow the below steps to connect to the database instance: 3. Copy the connection string for **PostgreSQL endpoint** and then use the following command to connect to the database: -{% code %} ``` psql postgresql://:$XATA_API_KEY@.sql.xata.sh/:?sslmode=require ``` -{% endcode %} ![Xata Database Access](../../.gitbook/assets/xata-db-access.png) @@ -181,7 +172,6 @@ You will need to create a **Recipe** in DevZero equiped with the neccesary tools 3. Click on **Create a recipe** and your recipe will be created. 4. Replace the recipe `yaml` file with the snippet below. Remember to replace the placeholder API key with the Key you noted down in the above steps: -{% code %} ``` version: "3" @@ -203,7 +193,6 @@ runtime: - name: XATA_API_KEY value: ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -218,20 +207,16 @@ Follow the below steps to connect to the database instance: 1. Go to DevBox and use the following command to authenticate your xata account: -{% code %} ``` xata auth login ``` -{% endcode %} 2. Choose the `Use an existing API key` option while authenticating, and then hit **Enter/Return** with the API Key shown when prompted. 3. Use the following command for access the database through Xata shell: -{% code %} ``` xata shell ``` -{% endcode %} 4. Select the **Workspace**, **Database** and **Branch** when prompted. @@ -267,7 +252,6 @@ You will need to create a **Recipe** in DevZero equipped with the necessary tool 3. Click on **Create a recipe**, and your recipe will be created. 4. Replace the recipe `yaml` file with the snippet below. Remember to replace the placeholder API key with the Key you noted down in the above steps: -{% code %} ``` version: "3" @@ -289,7 +273,6 @@ runtime: - name: XATA_API_KEY value: ``` -{% endcode %} ![DevZero Recipe](../../.gitbook/assets/devzero-recipe-yaml.png) @@ -304,20 +287,16 @@ Follow the below steps to connect to the database instance: 1. Go to DevBox and use the following command to authenticate your Xata account: -{% code %} ``` xata auth login ``` -{% endcode %} 2. Choose the `Use an existing API key` option while authenticating and then hit **Enter/Return** without entering the API Key when prompted. 3. Use the following command to access Databasebase through the Xata shell: -{% code %} ``` xata shell ``` -{% endcode %} 4. Select the **Workspace**, **Database** and **Branch** when prompted. @@ -328,4 +307,4 @@ xata shell ## Video Walkthrough -{% embed url="https://devzero.b-cdn.net/Devbox%20Xata%20Database%20.mp4" %} +[![Video Walkthrough](https://devzero.b-cdn.net/Devbox%20Xata%20Database%20.mp4)](https://devzero.b-cdn.net/Devbox%20Xata%20Database%20.mp4) diff --git a/how-to-guides/existing-network/README.md b/how-to-guides/existing-network/README.md index 5a55dc2..5786018 100644 --- a/how-to-guides/existing-network/README.md +++ b/how-to-guides/existing-network/README.md @@ -1,7 +1,6 @@ --- title: Existing Network --- -# Existing Network
diff --git a/how-to-guides/existing-network/connecting-to-aws.md b/how-to-guides/existing-network/connecting-to-aws.md index f38b96d..415b43e 100644 --- a/how-to-guides/existing-network/connecting-to-aws.md +++ b/how-to-guides/existing-network/connecting-to-aws.md @@ -3,7 +3,6 @@ description: Learn how to connect to AWS resources privately from a DevBox. title: Connecting to AWS --- -# Connecting to AWS If you're more of a visual learner, check out the [video tutorial](#video-walkthrough)! @@ -62,4 +61,4 @@ ping ## Video Walkthrough -{% embed url="https://devzero.b-cdn.net/how%20to%20guide%20AWS%20VPC.mp4" %} +[Video Walkthrough: How to Guide AWS VPC](https://devzero.b-cdn.net/how%20to%20guide%20AWS%20VPC.mp4) diff --git a/how-to-guides/existing-network/connecting-to-azure.md b/how-to-guides/existing-network/connecting-to-azure.md index a7fdf59..b03e43b 100644 --- a/how-to-guides/existing-network/connecting-to-azure.md +++ b/how-to-guides/existing-network/connecting-to-azure.md @@ -3,7 +3,6 @@ description: Learn how to connect to Azure resources privately from a DevBox. title: Connecting to Azure --- -# Connecting to Azure In this guide you will know how to setup a Bastion Host on Azure Infrastructure. This Bastion Host will allow you to connect to Private Azure services and use them directly from your DevBox. @@ -87,4 +86,4 @@ ping ## Video Walkthrough -{% embed url="https://devzero.b-cdn.net/how%20to%20guide%20AWS%20VPC.mp4" %} +[![Video Walkthrough](https://devzero.b-cdn.net/how%20to%20guide%20AWS%20VPC.mp4)](https://devzero.b-cdn.net/how%20to%20guide%20AWS%20VPC.mp4) diff --git a/how-to-guides/existing-network/connecting-to-gcp.md b/how-to-guides/existing-network/connecting-to-gcp.md index 81b850a..6c1b4e7 100644 --- a/how-to-guides/existing-network/connecting-to-gcp.md +++ b/how-to-guides/existing-network/connecting-to-gcp.md @@ -3,7 +3,6 @@ description: Learn how to connect to GCP resources privately from a DevBox. title: Connecting to GCP --- -# Connecting to GCP ## Step 1: Create a VPC @@ -32,45 +31,35 @@ title: Connecting to GCP 4. Attach public subnet to the instance from the VPC and assign it a public IP Address. 5. SSH into the machine and Install the DevZero CLI from the script: -{% code lineNumbers="false" %} ``` curl -fsSL https://get.devzero.io | sh ``` -{% endcode %} 6. Log into your account by executing: -{% code lineNumbers="false" %} ``` sudo dz auth login && sudo dz net connect ``` -{% endcode %} 7. Enable IP forwarding to access resources on VPC CIDR: -{% code lineNumbers="false" %} ``` echo 'net.ipv4.ip_forward = 1' | sudo tee -a /etc/sysctl.conf echo 'net.ipv6.conf.all.forwarding = 1' | sudo tee -a /etc/sysctl.conf sudo sysctl -p /etc/sysctl.conf ``` -{% endcode %} 8. Connect to DevZero network: -{% code lineNumbers="false" %} ``` sudo dz net connect --ssh --advertise-routes= ``` -{% endcode %} 9. Verify that the machine is connected to your DevZero network: -{% code lineNumbers="false" %} ``` dz net status ``` -{% endcode %} ![`dz net status`](../../.gitbook/assets/gcp-dz-net-status.png) diff --git a/how-to-guides/remote-desktop.md b/how-to-guides/remote-desktop.md index f0e81ba..b50baa7 100644 --- a/how-to-guides/remote-desktop.md +++ b/how-to-guides/remote-desktop.md @@ -1,7 +1,6 @@ --- title: Remote Desktop --- -# Remote Desktop You can access your DevBox interactively using Remote Desktop. @@ -57,9 +56,7 @@ You will be prompted to create a password. ## Connecting to a remote desktop -{% hint style="info" %} -Make sure your machine is connected to the DevZero network before connecting -{% endhint %} +> Make sure your machine is connected to the DevZero network before connecting You can connect to the remote desktop using the VNC protocol. @@ -70,8 +67,6 @@ vnc://:5901 On macOS, open **"Finder" > "Go" > "Connect to server".**\ Type in the server address above and click on "Connect", if promted, enter the password you've selected. -{% hint style="success" %} -For the Docker-based install, the default password is **vncpassword** -{% endhint %} +> For the Docker-based install, the default password is **vncpassword**

DevBox Remote Desktop

diff --git a/product-guides/getting-started/README.md b/product-guides/getting-started/README.md index 66bc6ef..e17e87c 100644 --- a/product-guides/getting-started/README.md +++ b/product-guides/getting-started/README.md @@ -1,7 +1,6 @@ --- title: Getting Started --- -# Getting Started
diff --git a/product-guides/getting-started/create-your-first-recipe.md b/product-guides/getting-started/create-your-first-recipe.md index 1d6495b..3faf46e 100644 --- a/product-guides/getting-started/create-your-first-recipe.md +++ b/product-guides/getting-started/create-your-first-recipe.md @@ -1,7 +1,6 @@ --- title: Create Your First Recipe --- -# Create Your First Recipe A [recipe](https://www.devzero.io/dashboard/workspaces/new) can be thought of as a template for a given environment. This could be an environment for development, testing, QA, or anything you need! diff --git a/product-guides/getting-started/inviting-teammates.md b/product-guides/getting-started/inviting-teammates.md index dfc053f..ce5e7b8 100644 --- a/product-guides/getting-started/inviting-teammates.md +++ b/product-guides/getting-started/inviting-teammates.md @@ -1,7 +1,6 @@ --- title: Inviting Users & Managing Permissions --- -# Inviting Users & Managing Permissions **Custom Roles:** Only the enterprise version of DevZero supports custom roles. All other tiers support the following standard user roles. diff --git a/product-guides/getting-started/launch-your-first-workspace.md b/product-guides/getting-started/launch-your-first-workspace.md index ccf0677..8d1ebf9 100644 --- a/product-guides/getting-started/launch-your-first-workspace.md +++ b/product-guides/getting-started/launch-your-first-workspace.md @@ -1,7 +1,6 @@ --- title: Launch and Connect to Your First Workspace --- -# Launch and Connect to Your First Workspace

How to launch a workspace

@@ -15,8 +14,6 @@ Current options for connecting to your workspace include: 2. Directing from VS Code - `dz ws code best-gull-psxv` 3. Via Code Server in browser - follow the onscreen instructions -{% hint style="info" %} -**Need to install our CLI?** Follow the instructions here: [CLI Installation](./../../references/cli-man-page/install-the-cli.md) -{% endhint %} +> **Need to install our CLI?** Follow the instructions here: [CLI Installation](./../../references/cli-man-page/install-the-cli.md) Once you're connected, you can use your Workspace just like any other development or testing environment. Then, when you're done with your work, you should use your remote Git provider to save your changes and you can delete your workspace. The next time you have work requiring that environment, simply launch a fresh Workspace from the related Recipe. diff --git a/product-guides/launch-and-connect-to-a-workspace.md b/product-guides/launch-and-connect-to-a-workspace.md index cdd6894..5daab99 100644 --- a/product-guides/launch-and-connect-to-a-workspace.md +++ b/product-guides/launch-and-connect-to-a-workspace.md @@ -1,7 +1,6 @@ --- title: Launch & Connect to a Workspace --- -# Launch & Connect to a Workspace

Launch a workspace

@@ -19,6 +18,4 @@ Current options for connecting to your workspace include: 2. Directing from VS Code - `dz ws code best-gull-psxv` 3. Via Code Server in browser - follow the onscreen instructions -{% hint style="info" %} -If you're having trouble launching or connecting to your workspace, we're here to help! Please reach out to support@devzero.io -{% endhint %} +> If you're having trouble launching or connecting to your workspace, we're here to help! Please reach out to support@devzero.io diff --git a/product-guides/managing-recipes.md b/product-guides/managing-recipes.md index 228aec9..644d0cc 100644 --- a/product-guides/managing-recipes.md +++ b/product-guides/managing-recipes.md @@ -1,7 +1,6 @@ --- title: Managing Recipes --- -# Managing Recipes
diff --git a/product-guides/managing-your-workspaces.md b/product-guides/managing-your-workspaces.md index ce1e40c..dbaaa04 100644 --- a/product-guides/managing-your-workspaces.md +++ b/product-guides/managing-your-workspaces.md @@ -1,7 +1,6 @@ --- title: Managing Your Workspaces --- -# Managing Your Workspaces Once launched, workspaces remain active so long as there is an active SSH connection or activity occurring within that workspace. After a prolonged period of inactivity, a workspace may be put in hibernation. This is fully stateful and will only add a few seconds to the relaunch time when reassuming that workspace. diff --git a/product-guides/settings/README.md b/product-guides/settings/README.md index ff98e19..fe47ec7 100644 --- a/product-guides/settings/README.md +++ b/product-guides/settings/README.md @@ -1,7 +1,6 @@ --- title: Settings --- -# Settings
diff --git a/product-guides/settings/team-settings.md b/product-guides/settings/team-settings.md index db8878c..142875b 100644 --- a/product-guides/settings/team-settings.md +++ b/product-guides/settings/team-settings.md @@ -1,8 +1,5 @@ --- title: Team Settings --- -# Team Settings -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** diff --git a/product-guides/settings/user-settings.md b/product-guides/settings/user-settings.md index 77aa07c..c52b3a9 100644 --- a/product-guides/settings/user-settings.md +++ b/product-guides/settings/user-settings.md @@ -1,8 +1,5 @@ --- title: User Settings --- -# User Settings -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** diff --git a/product-guides/using-a-workspace.md b/product-guides/using-a-workspace.md index 112a7bd..1da7c1a 100644 --- a/product-guides/using-a-workspace.md +++ b/product-guides/using-a-workspace.md @@ -1,8 +1,5 @@ --- title: Using a Workspace --- -# Using a Workspace -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** diff --git a/product-guides/writing-recipes.md b/product-guides/writing-recipes.md index 9fac309..5beacad 100644 --- a/product-guides/writing-recipes.md +++ b/product-guides/writing-recipes.md @@ -1,7 +1,6 @@ --- title: Writing Recipes --- -# Writing Recipes Recipe templates can currently created using our Web UI only. There is currently no way to edit the underlying YAML template, although we plan to make this feature accessible to power users soon!\ \ diff --git a/recipes/build-process.md b/recipes/build-process.md index 5290dc8..794608e 100644 --- a/recipes/build-process.md +++ b/recipes/build-process.md @@ -1,7 +1,6 @@ --- title: Build Process --- -# Build Process ## User Experience diff --git a/recipes/cloning-source-code.md b/recipes/cloning-source-code.md index 810b518..0726343 100644 --- a/recipes/cloning-source-code.md +++ b/recipes/cloning-source-code.md @@ -1,7 +1,6 @@ --- title: Cloning Source Code --- -# Cloning Source Code The repos block of our [recipe specification](syntax.md#git-clone) is used to clone code. This will use the [permissions of the GitHub application](https://docs.devzero.io/product-docs/admin/permissions) you have connected with DevZero. @@ -29,7 +28,6 @@ This usually applies to cases where you need to use secrets to clone code. To le You can use a [`command`](syntax.md#command) block to clone code directly: -{% code lineNumbers="true" %} ```yaml dev: commands: @@ -58,7 +56,6 @@ dev: directory: /home/devzero name: clone private repo over ssh using a deploy key ``` -{% endcode %} Some of the use cases where this is applicable: @@ -85,21 +82,17 @@ Some of the use cases where this is applicable: ## Step 3(a). Generate keys -{% code %} ``` ssh-keygen -t ed25519 -C "devzero-user@my-website.com" -f devzero_id25519 -P '' -q ``` -{% endcode %} ## Step 3(b). Add the public key to your Bitbucket repo's access keys First, copy the public key -{% code %} ``` cat ~/.ssh/devzero_id25519.pub | pbcopy ``` -{% endcode %} Then, paste it in the `Key` section in the pop-up box. @@ -113,11 +106,9 @@ Check the private key Copy it -{% code %} ``` cat ~/.ssh/devzero_id25519 | pbcopy ``` -{% endcode %} Then paste it into your team's secrets section at [https://www.devzero.io/dashboard/environment-variables/team](https://www.devzero.io/dashboard/environment-variables/team) @@ -129,7 +120,6 @@ Call it `BITBUCKET_PVT_KEY` (or whatever you please, but this is referenced in S Create a recipe and add a block that looks like the one below (check `line 5` to ensure naming). -{% code %} ```yaml dev: commands: @@ -142,7 +132,6 @@ dev: dir: . name: clone_from_bitbucket ``` -{% endcode %} ## Step 5. Launch a workspace from that recipe diff --git a/recipes/create-recipe.md b/recipes/create-recipe.md index 3ce2a21..af09451 100644 --- a/recipes/create-recipe.md +++ b/recipes/create-recipe.md @@ -1,11 +1,8 @@ --- title: Creating a Recipe --- -# Creating a Recipe -{% embed url="https://devzero.b-cdn.net/create-first-recipe.mp4" %} -Create your first DevZero Recipe! -{% endembed %} +[![Creating a Recipe](https://devzero.b-cdn.net/create-first-recipe.mp4)](https://devzero.b-cdn.net/create-first-recipe.mp4) ## 1. Create New Recipe @@ -27,9 +24,7 @@ Alternatively, you can launch a blank Recipe by clicking "Create a recipe" witho

Add code to your Recipe.

-{% hint style="info" %} -If you're not using GitHub or prefer a different authentication method, check out this section on [cloning source code](cloning-source-code.md). -{% endhint %} +> If you're not using GitHub or prefer a different authentication method, check out this section on [cloning source code](cloning-source-code.md). ## 4. Make Recipe Changes @@ -39,9 +34,7 @@ After you've successfully built your Recipe and are done iterating, you're ready

Make Recipe changes.

-{% hint style="info" %} - We provide detailed build logs to help you identify any errors in your build and make iterating on Recipes easy. -{% endhint %} +> We provide detailed build logs to help you identify any errors in your build and make iterating on Recipes easy. ## 5. Launch A Workspace from New Recipe and Connect diff --git a/recipes/custom-base.md b/recipes/custom-base.md index 023db81..205b68e 100644 --- a/recipes/custom-base.md +++ b/recipes/custom-base.md @@ -1,7 +1,6 @@ --- title: Recipe Base Images --- -# Recipe Base Images Custom base images are only support for our Enterprise customers. If you need a custom base image, please reach out to your support contact at DevZero.\ \ diff --git a/recipes/exec-stages.md b/recipes/exec-stages.md index ae06552..4bdf00c 100644 --- a/recipes/exec-stages.md +++ b/recipes/exec-stages.md @@ -1,7 +1,6 @@ --- title: Execution Stages --- -# Execution Stages ## Overview @@ -40,19 +39,15 @@ Each command block can be thought of as a layer in a Docker image. They are wrap `name` is used to help reference and understand what is being achieved in a command block. -{% hint style="info" %} -**Note** When invoking binaries, its always best-practice to reference them by their absolute paths. For example, `/usr/local/go/bin/go` instead of `go`. This relates to the following `warning` block. -{% endhint %} +> **Note** When invoking binaries, its always best-practice to reference them by their absolute paths. For example, `/usr/local/go/bin/go` instead of `go`. This relates to the following `warning` block. -{% hint style="warning" %} -**Warning** Environment variable set by calling `export` are not going to be available in subsequent command blocks. To use them in subsequent blocks, either write to some file, or to `/etc/environment`. Please see the previous `info` section for more ways to better utilize this. -{% endhint %} + +> **Warning** Environment variable set by calling `export` are not going to be available in subsequent command blocks. To use them in subsequent blocks, either write to some file, or to `/etc/environment`. Please see the previous `info` section for more ways to better utilize this. While recipe builds are cached, updating a lower layer (eg: the first step in your build steps) will cause the cache to get invalidated for all future steps. Therefore, if you edit step 1 in a 5-step recipe, steps 2, 3, 4 and 5 will get rebuilt. If you just edit step 5, the previous steps will be served out of the cache. Here's an example of some build-time steps: -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -90,7 +85,6 @@ build: directory: /home/devzero user: root ``` -{% endcode %} For more examples, see check the build commands in our [starter-templates](../references/starter-templates/ "mention"). @@ -115,15 +109,12 @@ While calling operations to kick-off indexing in IDEs is technically feasible in These steps are run using `systemctl` units at launch-time. Command blocks will be executed in the order in which they are specified in the recipe. -{% hint style="warning" %} -The **launch** block is used for commands to be executed as launch-time steps. -{% endhint %} +> The **launch** block is used for commands to be executed as launch-time steps. Other than that, the same rules from the [Build-time](exec-stages.md#build-time) stage apply. Here's an example of some launch-time steps: -{% code lineNumbers="true" %} ```yaml launch: steps: @@ -141,7 +132,6 @@ launch: directory: /home/devzero user: root ``` -{% endcode %}

Code block in a recipe

diff --git a/recipes/overview.md b/recipes/overview.md index 8ab9258..fcbc61b 100644 --- a/recipes/overview.md +++ b/recipes/overview.md @@ -1,7 +1,6 @@ --- title: Overview --- -# Overview ## What is a Recipe diff --git a/recipes/saving-recipes.md b/recipes/saving-recipes.md index 25ca31d..7dfeafd 100644 --- a/recipes/saving-recipes.md +++ b/recipes/saving-recipes.md @@ -1,11 +1,8 @@ --- title: Sharing Recipes --- -# Sharing Recipes -{% hint style="info" %} -If you don't have any recipes yet, please follow the "[Creating a Recipe](create-recipe.md)" guide first. -{% endhint %} +> If you don't have any recipes yet, please follow the "[Creating a Recipe](create-recipe.md)" guide first. ## Sharing a recipe link with your teammates diff --git a/recipes/syntax.md b/recipes/syntax.md index 4fa85f9..eeff3eb 100644 --- a/recipes/syntax.md +++ b/recipes/syntax.md @@ -5,7 +5,6 @@ description: >- title: Recipe Syntax --- -# Recipe Syntax A recipe is a definition of a workspace. It consists of a base workspace configuration, and a set of steps to be executed. Let's look at a simple recipe: @@ -68,9 +67,7 @@ You can have multiline commands, for example: Creates a file with some content. -{% hint style="info" %} -Paths are not using shell expansion, so you have to write out /home/devzero/projects rather than \~/projects -{% endhint %} +> Paths are not using shell expansion, so you have to write out /home/devzero/projects rather than \~/projects ```yaml - type: file @@ -85,9 +82,7 @@ Paths are not using shell expansion, so you have to write out /home/devzero/proj Creates a directory. -{% hint style="info" %} -Same as with files path is not expanded, so \~ and environment variables will not be replaced with corresponding values -{% endhint %} +> Same as with files path is not expanded, so \~ and environment variables will not be replaced with corresponding values ```yaml - type: directory @@ -155,9 +150,7 @@ Semantics for the directory are explained in [git documentation](https://git-scm Commands often require either their environment to be set up correctly, or secrets to access private resources. Both of these can be managed on [a per team or a per user basis](../environment-variables/env-vars.md). -{% hint style="info" %} -System secrets are in the namespace `devzero` currently only one such secret exists `devzero.GITHUB_ACCESS_TOKEN` this token is populated using github account information for the user who is invoking the build -{% endhint %} +> System secrets are in the namespace `devzero` currently only one such secret exists `devzero.GITHUB_ACCESS_TOKEN` this token is populated using github account information for the user who is invoking the build ### Environment variables @@ -332,6 +325,4 @@ build: ``` -{% hint style="info" %} -Note: User secrets cannot be accessed during build time. However, all user secrets are automatically available as environment variables within each user's workspace. -{% endhint %} +> Note: User secrets cannot be accessed during build time. However, all user secrets are automatically available as environment variables within each user's workspace. diff --git a/references/cli-man-page/README.md b/references/cli-man-page/README.md index 2a7eb11..523a91e 100644 --- a/references/cli-man-page/README.md +++ b/references/cli-man-page/README.md @@ -1,28 +1,15 @@ --- title: CLI Reference --- -# CLI Reference -{% content-ref url="install-the-cli.md" %} [install-the-cli.md](install-the-cli.md) -{% endcontent-ref %} -{% content-ref url="update.md" %} [update.md](update.md) -{% endcontent-ref %} -{% content-ref url="uninstall.md" %} [uninstall.md](uninstall.md) -{% endcontent-ref %} -{% content-ref url="supported-os.md" %} [supported-os.md](supported-os.md) -{% endcontent-ref %} -{% content-ref url="alternative-install.md" %} [alternative-install.md](alternative-install.md) -{% endcontent-ref %} -{% content-ref url="help-commands.md" %} [help-commands.md](help-commands.md) -{% endcontent-ref %} diff --git a/references/cli-man-page/alternative-install.md b/references/cli-man-page/alternative-install.md index 93de1b6..d8af516 100644 --- a/references/cli-man-page/alternative-install.md +++ b/references/cli-man-page/alternative-install.md @@ -2,13 +2,10 @@ title: Alternative Installation Steps --- -# Alternative Installation Steps If you happen to be running an unsupported configuration (i.e. where you don't have sudo access), we got your back! We offer support on a best-effort basis for most Linux distributions & macOS versions, via statically-compiled binaries. -{% hint style="info" %} -As you're deviating from the "happy path", you'll need to run some extra commands in order to get the DevZero CLI working on your machine. If you'd like assistance with this, please contact us at support@devzero.io and we'd be happy to guide you through these steps. -{% endhint %} +> As you're deviating from the "happy path", you'll need to run some extra commands in order to get the DevZero CLI working on your machine. If you'd like assistance with this, please contact us at support@devzero.io and we'd be happy to guide you through these steps. We generally support most arm64 / amd64 Linux systems, as well as Apple Silicon & Intel macOS systems. If you're running - say, a SPARC / RISC-V machine, we don't support that at this time. @@ -47,38 +44,30 @@ If you're feeling adventurous, these links are for the `latest` release track, w ## 2. Unpack the tarball -{% code %} ``` tar xvf dz.tar.gz ``` -{% endcode %} This should produce one file, called `dzcmd`. ## 3. Create symlinks -{% code %} ``` ln -s dzcmd dz ln -s dzcmd dznetd ``` -{% endcode %} ## 4. Start dznetd -{% code %} ``` sudo ./dznetd ``` -{% endcode %} ## 5. Connect to your team's network -{% code %} ``` sudo ./dz net connect ``` -{% endcode %} ## 6. Success diff --git a/references/cli-man-page/help-commands.md b/references/cli-man-page/help-commands.md index 1b2784f..98594cd 100644 --- a/references/cli-man-page/help-commands.md +++ b/references/cli-man-page/help-commands.md @@ -1,11 +1,9 @@ --- title: Help Commands --- -# Help Commands ## dz -{% code %} ``` % dz -h Welcome to the DevZero CLI! @@ -30,11 +28,9 @@ Available Commands: Flags: -h, --help help for dz ``` -{% endcode %} ## dz > workspace -{% code %} ``` % dz workspace -h Operate against and manage your workspaces @@ -55,11 +51,9 @@ Available Commands: Flags: -h, --help help for workspace ``` -{% endcode %} ## dz > network -{% code %} ``` % dz network -h Control your connection to your team's DevZero network. @@ -79,4 +73,3 @@ Available Commands: Flags: -h, --help help for network ``` -{% endcode %} diff --git a/references/cli-man-page/install-the-cli.md b/references/cli-man-page/install-the-cli.md index a2bb63f..66d4a7d 100644 --- a/references/cli-man-page/install-the-cli.md +++ b/references/cli-man-page/install-the-cli.md @@ -1,7 +1,6 @@ --- title: Install the CLI --- -# Install the CLI These instructions will guide you through the DevZero CLI installation process based on your local operating system. The CLI enables building, launching, and connecting to workspaces. @@ -12,11 +11,9 @@ These instructions will guide you through the DevZero CLI installation process b **Make sure to run the following commands after installation to continue with the setup process:** -{% code fullWidth="true" %} ``` dz auth login ``` -{% endcode %} ``` dz net connect diff --git a/references/cli-man-page/supported-os.md b/references/cli-man-page/supported-os.md index b697cc4..cacf234 100644 --- a/references/cli-man-page/supported-os.md +++ b/references/cli-man-page/supported-os.md @@ -1,7 +1,6 @@ --- title: Supported Operating Systems --- -# Supported Operating Systems At DevZero, every CLI update undergoes testing for the following conditions: diff --git a/references/cli-man-page/uninstall.md b/references/cli-man-page/uninstall.md index bf5dbf0..fb4a856 100644 --- a/references/cli-man-page/uninstall.md +++ b/references/cli-man-page/uninstall.md @@ -1,7 +1,6 @@ --- title: Uninstall dz --- -# Uninstall dz To remove the CLI and uninstall the daemon, run: diff --git a/references/cli-man-page/update.md b/references/cli-man-page/update.md index 54cb1f3..bea0cf3 100644 --- a/references/cli-man-page/update.md +++ b/references/cli-man-page/update.md @@ -1,7 +1,6 @@ --- title: Updating the CLI --- -# Updating the CLI A single CLI (called `dz`) is used to interact with DevZero control plane. Check out the [CLI main page](../../references/cli-man-page/) for DevZero CLI options or use. diff --git a/references/ide-setup/README.md b/references/ide-setup/README.md index 2b3e5cd..ec69a18 100644 --- a/references/ide-setup/README.md +++ b/references/ide-setup/README.md @@ -1,7 +1,6 @@ --- title: IDE Setup --- -# IDE Setup
diff --git a/references/ide-setup/browser-ide.md b/references/ide-setup/browser-ide.md index 77d03da..c9b58d2 100644 --- a/references/ide-setup/browser-ide.md +++ b/references/ide-setup/browser-ide.md @@ -1,11 +1,9 @@ --- title: Browser IDE (using code-server) --- -# Browser IDE (using code-server) There's a [walkthrough video](#walkthrough-video) at the bottom of this page if you want to see how everything looks! -{% code lineNumbers="true" %} ``` version: "3" @@ -62,8 +60,7 @@ build: systemctl enable code-server # Enable code-server to start on system boot user: root # Execute the command as the root user ``` -{% endcode %} ## Walkthrough Video -{% embed url="https://devzero.b-cdn.net/browser-ide.mp4" %} +[![Walkthrough Video](https://devzero.b-cdn.net/browser-ide.mp4)](https://devzero.b-cdn.net/browser-ide.mp4) diff --git a/references/ide-setup/cursor.md b/references/ide-setup/cursor.md index 5273f50..0da8bac 100644 --- a/references/ide-setup/cursor.md +++ b/references/ide-setup/cursor.md @@ -1,24 +1,19 @@ --- title: Cursor --- -# Cursor First, get the name of the workspace that you want to connect VS Code to... -{% code %} ``` # to get the workspace name dz workspace ls ``` -{% endcode %} Then, run ... -{% code %} ``` dz workspace cursor # if your workspace is called energetic-donkey-fewd # this is dz workspace cursor energetic-donkey-fewd ``` -{% endcode %} diff --git a/references/ide-setup/jetbrains.md b/references/ide-setup/jetbrains.md index c43798a..2d10543 100644 --- a/references/ide-setup/jetbrains.md +++ b/references/ide-setup/jetbrains.md @@ -1,7 +1,6 @@ --- title: JetBrains --- -# JetBrains This doc contains information about connecting to DevZero workspaces using any of the following JetBrains IDEs: @@ -32,9 +31,7 @@ This doc contains information about connecting to DevZero workspaces using any o

Select your IDE

-{% hint style="info" %} -The default path for your cloned code is `/home/devzero` -{% endhint %} +> The default path for your cloned code is `/home/devzero` - Under **Connections > SSH**, you should see your workspace listed. @@ -55,9 +52,7 @@ The default path for your cloned code is `/home/devzero`

Select your IDE

-{% hint style="info" %} -The default path for your cloned code is `/home/devzero` -{% endhint %} +> The default path for your cloned code is `/home/devzero` - Under **Remote Development > SSH**, you should see your workspace listed. diff --git a/references/ide-setup/ssh.md b/references/ide-setup/ssh.md index 9f5834a..353a0c3 100644 --- a/references/ide-setup/ssh.md +++ b/references/ide-setup/ssh.md @@ -1,33 +1,26 @@ --- title: SSH --- -# SSH First, get the name of the workspace that you want to connect VS Code to... -{% code %} ``` # to get the workspace name dz workspace ls ``` -{% endcode %} Then, run ... -{% code %} ``` dz workspace connect # if your workspace is called absconding-rhino-mega dz workspace connect absconding-rhino-mega ``` -{% endcode %} Or if you prefer you can connect via SSH client -{% code %} ``` # if your workspace is called absconding-rhino-mega ssh devzero@absconding-rhino-mega ``` -{% endcode %} diff --git a/references/ide-setup/vscode.md b/references/ide-setup/vscode.md index 40133a1..5363bca 100644 --- a/references/ide-setup/vscode.md +++ b/references/ide-setup/vscode.md @@ -1,24 +1,19 @@ --- title: Visual Studio Code --- -# Visual Studio Code First, get the name of the workspace that you want to connect VS Code to... -{% code %} ``` # to get the workspace name dz workspace ls ``` -{% endcode %} Then, run ... -{% code %} ``` dz workspace code # if your workspace is called tremendous-monkey-fewd # this is dz workspace code tremendous-monkey-fewd ``` -{% endcode %} diff --git a/references/ide-setup/web-shell.md b/references/ide-setup/web-shell.md index 7bd5ec6..6fdcf31 100644 --- a/references/ide-setup/web-shell.md +++ b/references/ide-setup/web-shell.md @@ -1,11 +1,9 @@ --- title: Web Shell (using GoTTY) --- -# Web Shell (using GoTTY) There's a [walkthrough video](#walkthrough-video) at the bottom of this page if you want to see how everything looks! -{% code lineNumbers="true" %} ``` version: "3" build: @@ -44,8 +42,7 @@ build: systemctl enable gotty.service user: root ``` -{% endcode %} ## Walkthrough Video -{% embed url="https://devzero.b-cdn.net/Web%20shell.mp4" %} +[![Walkthrough Video](https://devzero.b-cdn.net/Web%20shell.mp4)](https://devzero.b-cdn.net/Web%20shell.mp4) diff --git a/references/starter-templates/build-tools/README.md b/references/starter-templates/build-tools/README.md index 6d887b5..14ff08a 100644 --- a/references/starter-templates/build-tools/README.md +++ b/references/starter-templates/build-tools/README.md @@ -1,6 +1,5 @@ --- title: Build Tool Templates --- -# Build Tool Templates
Bazelbazel.mdbazel.png
Dockerdocker.mddocker.png
Nixnix.mdnix.png
diff --git a/references/starter-templates/build-tools/bazel.md b/references/starter-templates/build-tools/bazel.md index 1c2525b..d83334d 100644 --- a/references/starter-templates/build-tools/bazel.md +++ b/references/starter-templates/build-tools/bazel.md @@ -1,9 +1,7 @@ --- title: Bazel --- -# Bazel -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -20,4 +18,3 @@ build: - jdk1.8 distribution: stable ``` -{% endcode %} diff --git a/references/starter-templates/build-tools/docker.md b/references/starter-templates/build-tools/docker.md index aaa17e9..034d234 100644 --- a/references/starter-templates/build-tools/docker.md +++ b/references/starter-templates/build-tools/docker.md @@ -1,9 +1,7 @@ --- title: Docker and Docker Compose --- -# Docker and Docker Compose -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -26,4 +24,3 @@ build: directory: /home/devzero user: root ``` -{% endcode %} diff --git a/references/starter-templates/build-tools/nix.md b/references/starter-templates/build-tools/nix.md index 9a5e7b9..b11b6b6 100644 --- a/references/starter-templates/build-tools/nix.md +++ b/references/starter-templates/build-tools/nix.md @@ -1,9 +1,7 @@ --- title: Nix --- -# Nix -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -16,4 +14,3 @@ build: . ~/.nix-profile/etc/profile.d/nix.sh shell: /bin/bash -l {} ``` -{% endcode %} diff --git a/references/starter-templates/ci-cd/README.md b/references/starter-templates/ci-cd/README.md index 8bf2e0d..cf6eea4 100644 --- a/references/starter-templates/ci-cd/README.md +++ b/references/starter-templates/ci-cd/README.md @@ -1,4 +1,3 @@ --- title: CI/CD --- -# CI/CD diff --git a/references/starter-templates/ci-cd/argo.md b/references/starter-templates/ci-cd/argo.md index 19743e4..93a7c64 100644 --- a/references/starter-templates/ci-cd/argo.md +++ b/references/starter-templates/ci-cd/argo.md @@ -1,9 +1,7 @@ --- title: Argo CD --- -# Argo CD -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -18,4 +16,3 @@ build: mv ./argo-linux-amd64 /usr/local/bin/argo user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/ci-cd/bazel-buildfarm.md b/references/starter-templates/ci-cd/bazel-buildfarm.md index ba39068..cce1053 100644 --- a/references/starter-templates/ci-cd/bazel-buildfarm.md +++ b/references/starter-templates/ci-cd/bazel-buildfarm.md @@ -1,7 +1,6 @@ --- title: Bazel Buildfarm --- -# Bazel Buildfarm ```yaml version: "3" diff --git a/references/starter-templates/ci-cd/github-actions.md b/references/starter-templates/ci-cd/github-actions.md index 57dd465..1528804 100644 --- a/references/starter-templates/ci-cd/github-actions.md +++ b/references/starter-templates/ci-cd/github-actions.md @@ -1,7 +1,6 @@ --- title: GitHub Actions --- -# GitHub Actions ## Self-hosted runner @@ -45,14 +44,8 @@ launch: ## Actions Runner Controller -{% hing style="warning" %} - -The Actions Runner Controller directions are in beta and running tests which require Docker aren't supported yet -{% endhint %} - -{% hint style="info" %} -Adjust the `INSTALLATION_NAME`, `NAMESPACE`, `GITHUB_CONFIG_URL`, and `GITHUB_PAT` variables as needed. -{% endhint %} +> The Actions Runner Controller directions are in beta and running tests which require Docker aren't supported yet +> Adjust the `INSTALLATION_NAME`, `NAMESPACE`, `GITHUB_CONFIG_URL`, and `GITHUB_PAT` variables as needed. ```yaml version: "3" diff --git a/references/starter-templates/databases/README.md b/references/starter-templates/databases/README.md index b2f9f7f..6a0dbac 100644 --- a/references/starter-templates/databases/README.md +++ b/references/starter-templates/databases/README.md @@ -1,7 +1,6 @@ --- title: Database tools --- -# Database tools diff --git a/references/starter-templates/databases/mongodb.md b/references/starter-templates/databases/mongodb.md index 2fd943f..eb8f211 100644 --- a/references/starter-templates/databases/mongodb.md +++ b/references/starter-templates/databases/mongodb.md @@ -1,9 +1,7 @@ --- title: MongoDB --- -# MongoDB -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -34,4 +32,3 @@ build: sudo cp mongodb-database-tools-ubuntu2204-x86_64-$VERSION/bin/* /usr/local/bin/ rm -rf mongodb-database-tools-ubuntu2204-x86_64-$VERSION* ``` -{% endcode %} diff --git a/references/starter-templates/databases/postgres.md b/references/starter-templates/databases/postgres.md index e85e0af..c1c11e3 100644 --- a/references/starter-templates/databases/postgres.md +++ b/references/starter-templates/databases/postgres.md @@ -1,9 +1,7 @@ --- title: Postgres --- -# Postgres -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -37,4 +35,3 @@ launch: sudo -u postgres createdb devzero -O devzero user: root ``` -{% endcode %} diff --git a/references/starter-templates/infra/README.md b/references/starter-templates/infra/README.md index 41d9b96..6ccfaa8 100644 --- a/references/starter-templates/infra/README.md +++ b/references/starter-templates/infra/README.md @@ -1,7 +1,6 @@ --- title: Infra Templates --- -# Infra Templates
diff --git a/references/starter-templates/infra/argo.md b/references/starter-templates/infra/argo.md index 19743e4..93a7c64 100644 --- a/references/starter-templates/infra/argo.md +++ b/references/starter-templates/infra/argo.md @@ -1,9 +1,7 @@ --- title: Argo CD --- -# Argo CD -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -18,4 +16,3 @@ build: mv ./argo-linux-amd64 /usr/local/bin/argo user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/infra/helm.md b/references/starter-templates/infra/helm.md index 500d287..01a7157 100644 --- a/references/starter-templates/infra/helm.md +++ b/references/starter-templates/infra/helm.md @@ -1,9 +1,7 @@ --- title: Helm --- -# Helm -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -18,4 +16,3 @@ build: rm get_helm.sh user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/infra/k9s.md b/references/starter-templates/infra/k9s.md index e902909..1341d23 100644 --- a/references/starter-templates/infra/k9s.md +++ b/references/starter-templates/infra/k9s.md @@ -1,9 +1,7 @@ --- title: K9s --- -# K9s -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -19,4 +17,3 @@ build: sudo mv k9s_Linux_amd64/k9s /usr/local/bin/ rm -rf k9s_Linux_amd64* ``` -{% endcode %} diff --git a/references/starter-templates/infra/kubectl.md b/references/starter-templates/infra/kubectl.md index e2f0d16..7b44bb7 100644 --- a/references/starter-templates/infra/kubectl.md +++ b/references/starter-templates/infra/kubectl.md @@ -1,9 +1,7 @@ --- title: Kubectl --- -# Kubectl -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -17,4 +15,3 @@ build: rm kubectl user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/infra/kubectx-kubens.md b/references/starter-templates/infra/kubectx-kubens.md index 46c06f8..d59e80d 100644 --- a/references/starter-templates/infra/kubectx-kubens.md +++ b/references/starter-templates/infra/kubectx-kubens.md @@ -1,9 +1,7 @@ --- title: Kubectx and Kubens --- -# Kubectx and Kubens -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -19,4 +17,3 @@ build: chmod +x /usr/local/bin/kubens user: root ``` -{% endcode %} diff --git a/references/starter-templates/infra/pulumi.md b/references/starter-templates/infra/pulumi.md index aeda665..6f421ec 100644 --- a/references/starter-templates/infra/pulumi.md +++ b/references/starter-templates/infra/pulumi.md @@ -1,9 +1,7 @@ --- title: Pulumi --- -# Pulumi -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -16,4 +14,3 @@ build: echo 'export PATH=$PATH:/home/devzero/.pulumi/bin' | sudo tee /etc/profile.d/151-pulumi-installation.sh user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/infra/skaffold.md b/references/starter-templates/infra/skaffold.md index 788f015..4265fe2 100644 --- a/references/starter-templates/infra/skaffold.md +++ b/references/starter-templates/infra/skaffold.md @@ -1,9 +1,7 @@ --- title: Skaffold --- -# Skaffold -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -17,4 +15,3 @@ build: rm skaffold user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/infra/terraform.md b/references/starter-templates/infra/terraform.md index c02421e..65f5be1 100644 --- a/references/starter-templates/infra/terraform.md +++ b/references/starter-templates/infra/terraform.md @@ -1,9 +1,7 @@ --- title: Terraform --- -# Terraform -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -15,4 +13,3 @@ build: repository: https://apt.releases.hashicorp.com components: ["main"] ``` -{% endcode %} diff --git a/references/starter-templates/languages/README.md b/references/starter-templates/languages/README.md index 0243ed6..0bde192 100644 --- a/references/starter-templates/languages/README.md +++ b/references/starter-templates/languages/README.md @@ -1,6 +1,5 @@ --- title: Programming Languages --- -# Programming Languages
C#c-sharp.mdc-sharp.png
Cc.mdc.png
C++cpp.mdcpp.png
Dartdart.mddart.png
Gogo.mdgo.png
Javajava.mdjava.png
JavaScriptjavascript.mdjavascript.png
PHPphp.mdphp.png
Pythonpython.mdpython.png
Rubyruby.mdruby.png
Rustrust.mdrust.png
diff --git a/references/starter-templates/languages/c-sharp.md b/references/starter-templates/languages/c-sharp.md index 2c63541..871199b 100644 --- a/references/starter-templates/languages/c-sharp.md +++ b/references/starter-templates/languages/c-sharp.md @@ -1,9 +1,7 @@ --- title: C --- -# C -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -14,4 +12,3 @@ build: - type: apt-get packages: ["dotnet-sdk-8.0", "aspnetcore-runtime-8.0"] ``` -{% endcode %} diff --git a/references/starter-templates/languages/c.md b/references/starter-templates/languages/c.md index 1a4551c..e558bcf 100644 --- a/references/starter-templates/languages/c.md +++ b/references/starter-templates/languages/c.md @@ -1,9 +1,7 @@ --- title: C --- -# C -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -11,4 +9,3 @@ build: - type: apt-get packages: ["gcc"] ``` -{% endcode %} diff --git a/references/starter-templates/languages/cpp.md b/references/starter-templates/languages/cpp.md index 46dce0a..8ff55db 100644 --- a/references/starter-templates/languages/cpp.md +++ b/references/starter-templates/languages/cpp.md @@ -1,9 +1,7 @@ --- title: C+ --- -# C+ -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -11,4 +9,3 @@ build: - type: apt-get packages: ["g++"] ``` -{% endcode %} diff --git a/references/starter-templates/languages/dart.md b/references/starter-templates/languages/dart.md index 12e983d..3fbc436 100644 --- a/references/starter-templates/languages/dart.md +++ b/references/starter-templates/languages/dart.md @@ -1,9 +1,7 @@ --- title: Dart --- -# Dart -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -19,4 +17,3 @@ build: chmod +x /etc/profile.d/dart-installation.sh user: root ``` -{% endcode %} diff --git a/references/starter-templates/languages/go.md b/references/starter-templates/languages/go.md index c35c686..c9f1efa 100644 --- a/references/starter-templates/languages/go.md +++ b/references/starter-templates/languages/go.md @@ -1,9 +1,7 @@ --- title: Go --- -# Go -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -34,4 +32,3 @@ build: echo 'export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin' | tee -a /etc/profile.d/go-installation.sh user: root ``` -{% endcode %} diff --git a/references/starter-templates/languages/java.md b/references/starter-templates/languages/java.md index edb9d1a..d1c97d3 100644 --- a/references/starter-templates/languages/java.md +++ b/references/starter-templates/languages/java.md @@ -1,9 +1,7 @@ --- title: Java --- -# Java -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -16,4 +14,3 @@ build: . "$HOME/.sdkman/bin/sdkman-init.sh" sdk install java ``` -{% endcode %} diff --git a/references/starter-templates/languages/javascript.md b/references/starter-templates/languages/javascript.md index 87317d7..f4b1a73 100644 --- a/references/starter-templates/languages/javascript.md +++ b/references/starter-templates/languages/javascript.md @@ -1,9 +1,7 @@ --- title: 'JavaScript (incl. Yarn, NVM' --- -# JavaScript (incl. Yarn, NVM -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -19,4 +17,3 @@ build: echo '. $HOME/.nvm/nvm.sh' >> $HOME/.zshrc npm install --global yarn ``` -{% endcode %} diff --git a/references/starter-templates/languages/php.md b/references/starter-templates/languages/php.md index f064748..d50188b 100644 --- a/references/starter-templates/languages/php.md +++ b/references/starter-templates/languages/php.md @@ -1,9 +1,7 @@ --- title: PHP --- -# PHP -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -20,4 +18,3 @@ build: directory: /home/devzero user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/languages/python.md b/references/starter-templates/languages/python.md index 448d232..774cfac 100644 --- a/references/starter-templates/languages/python.md +++ b/references/starter-templates/languages/python.md @@ -1,9 +1,7 @@ --- title: Python --- -# Python -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -20,7 +18,6 @@ build: python get-pip.py rm get-pip.py ``` -{% endcode %} To automatically enter a `virtualenv` when you connect to a workspace, configure your `.bashrc` file (see the last build step in the recipe below): diff --git a/references/starter-templates/languages/ruby.md b/references/starter-templates/languages/ruby.md index 63b91ec..b6f488d 100644 --- a/references/starter-templates/languages/ruby.md +++ b/references/starter-templates/languages/ruby.md @@ -1,9 +1,7 @@ --- title: Ruby --- -# Ruby -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -20,4 +18,3 @@ build: echo 'export PATH="$HOME/.rbenv/bin:$PATH"' | sudo tee -a /etc/profile.d/ruby-installation.sh sudo chmod +x /etc/profile.d/ruby-installation.sh ``` -{% endcode %} diff --git a/references/starter-templates/languages/rust.md b/references/starter-templates/languages/rust.md index 1330784..69a70e4 100644 --- a/references/starter-templates/languages/rust.md +++ b/references/starter-templates/languages/rust.md @@ -1,9 +1,7 @@ --- title: Rust --- -# Rust -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -17,4 +15,3 @@ build: rustup install 1.80.0 rustup default 1.80.0 ``` -{% endcode %} diff --git a/references/starter-templates/third-party/README.md b/references/starter-templates/third-party/README.md index 0f956a0..cd78407 100644 --- a/references/starter-templates/third-party/README.md +++ b/references/starter-templates/third-party/README.md @@ -1,7 +1,6 @@ --- title: Tools to interact w/ 3rd party cloud --- -# Tools to interact w/ 3rd party cloud ## Infra tools diff --git a/references/starter-templates/third-party/aws.md b/references/starter-templates/third-party/aws.md index 7e77775..6995c86 100644 --- a/references/starter-templates/third-party/aws.md +++ b/references/starter-templates/third-party/aws.md @@ -1,11 +1,9 @@ --- title: AWS --- -# AWS ## AWS CLI -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -20,11 +18,9 @@ build: sudo ./aws/install rm -rf aws awscliv2.zip ``` -{% endcode %} ## Docker Credential ECR Login -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -38,4 +34,3 @@ build: chmod +x docker-credential-ecr-login sudo mv docker-credential-ecr-login /usr/local/bin ``` -{% endcode %} diff --git a/references/starter-templates/third-party/azure.md b/references/starter-templates/third-party/azure.md index c834d4e..6a94932 100644 --- a/references/starter-templates/third-party/azure.md +++ b/references/starter-templates/third-party/azure.md @@ -1,9 +1,7 @@ --- title: Azure - az CLI --- -# Azure - az CLI -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -15,4 +13,3 @@ build: curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/third-party/gcp.md b/references/starter-templates/third-party/gcp.md index 2d0ca1f..3a6c32d 100644 --- a/references/starter-templates/third-party/gcp.md +++ b/references/starter-templates/third-party/gcp.md @@ -1,9 +1,7 @@ --- title: GCP - gcloud CLI --- -# GCP - gcloud CLI -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -18,4 +16,3 @@ build: sudo apt-get update && sudo apt-get install google-cloud-cli user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/third-party/github.md b/references/starter-templates/third-party/github.md index f63d311..4856baa 100644 --- a/references/starter-templates/third-party/github.md +++ b/references/starter-templates/third-party/github.md @@ -1,9 +1,7 @@ --- title: GitHub CLI --- -# GitHub CLI -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -20,4 +18,3 @@ build: sudo apt install gh -y user: devzero ``` -{% endcode %} diff --git a/references/starter-templates/third-party/gitlab.md b/references/starter-templates/third-party/gitlab.md index 377728c..ffa1aa6 100644 --- a/references/starter-templates/third-party/gitlab.md +++ b/references/starter-templates/third-party/gitlab.md @@ -1,9 +1,7 @@ --- title: GitLab - glab CLI --- -# GitLab - glab CLI -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -16,4 +14,3 @@ build: sudo dpkg -i glab_1.41.0_Linux_x86_64.deb user: devzero ``` -{% endcode %} diff --git a/references/terminology.md b/references/terminology.md index 3837998..2f5b0de 100644 --- a/references/terminology.md +++ b/references/terminology.md @@ -1,7 +1,6 @@ --- title: Terminology --- -# Terminology ## DevZero Terminology diff --git a/troubleshooting/command-line.md b/troubleshooting/command-line.md index 6a63149..f30b545 100644 --- a/troubleshooting/command-line.md +++ b/troubleshooting/command-line.md @@ -1,10 +1,7 @@ --- title: Command Line --- -# Command Line -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** Need help? Reach out to [support@devzero.io](mailto:support@devzero.io) diff --git a/troubleshooting/jetbrains.md b/troubleshooting/jetbrains.md index 4694e41..ae9b632 100644 --- a/troubleshooting/jetbrains.md +++ b/troubleshooting/jetbrains.md @@ -1,8 +1,5 @@ --- title: JetBrains --- -# JetBrains -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** diff --git a/troubleshooting/network.md b/troubleshooting/network.md index cc576c0..98f3b6b 100644 --- a/troubleshooting/network.md +++ b/troubleshooting/network.md @@ -1,7 +1,6 @@ --- title: Network --- -# Network
diff --git a/troubleshooting/recipes.md b/troubleshooting/recipes.md index 9922500..a665185 100644 --- a/troubleshooting/recipes.md +++ b/troubleshooting/recipes.md @@ -1,24 +1,19 @@ --- title: Recipes --- -# Recipes
ERROR: mount options is too long You are probably reading this because you encountered an error that looks like this when building a recipe: -{% code %} ``` ERROR: mount options is too long------ > mkfile /usr/lib/devzero/build-scripts/....: ------ error: failed to solve: mount options is too long Build failed with code 1 ``` -{% endcode %} This is happening because the container image that's getting created for your recipe has too many layers, i.e., too many `build-steps`. You can fix it by combining a few build steps together and overall, reducing the number of explicit build steps in your recipe. -{% hint style="info" %} -Our general guideline is to keep this under 100 steps. -{% endhint %} +> Our general guideline is to keep this under 100 steps. To learn more about _why_ something like this happens, [check this out](https://github.com/docker/docs/issues/8230#issuecomment-468630187). This limitation is due to how Linux handles syscalls, and various container registries also impose this limit.
@@ -27,7 +22,6 @@ To learn more about _why_ something like this happens, [check this out](https:// How to enable Docker in a workspace... You are probably reading this because you encountered the following error when trying to execute a docker related error: -{% code %} ``` $ docker run hello-world docker: permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Head "http://%2Fvar%2Frun%2Fdocker.sock/_ping": dial unix /var/run/docker.sock: connect: permission denied. @@ -36,11 +30,9 @@ See 'docker run --help'. $ docker ps permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Get "http://%2Fvar%2Frun%2Fdocker.sock/v1.45/containers/json": dial unix /var/run/docker.sock: connect: permission denied ``` -{% endcode %} To get Docker working in your workspace, add the following command to your recipe: -{% code lineNumbers="true" %} ```yaml - command: |- @@ -54,7 +46,6 @@ To get Docker working in your workspace, add the following command to your recip sudo systemctl enable containerd.service name: run_at_startup_script ``` -{% endcode %} In order for this to work, please be sure the command name starts with `run_at_startup_`.
diff --git a/troubleshooting/vs-code.md b/troubleshooting/vs-code.md index 1a15e96..5fc75d2 100644 --- a/troubleshooting/vs-code.md +++ b/troubleshooting/vs-code.md @@ -1,7 +1,6 @@ --- title: Recipes --- -# Recipes
diff --git a/troubleshooting/web-console.md b/troubleshooting/web-console.md index d6ad557..45a3d60 100644 --- a/troubleshooting/web-console.md +++ b/troubleshooting/web-console.md @@ -1,10 +1,7 @@ --- title: Web Console --- -# Web Console -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** Need help? Reach out to [support@devzero.io](mailto:support@devzero.io) diff --git a/troubleshooting/workspaces.md b/troubleshooting/workspaces.md index e682f8e..7a4d40e 100644 --- a/troubleshooting/workspaces.md +++ b/troubleshooting/workspaces.md @@ -1,7 +1,6 @@ --- title: Workspaces --- -# Workspaces
diff --git a/use-cases/README.md b/use-cases/README.md index a397f63..55f8542 100644 --- a/use-cases/README.md +++ b/use-cases/README.md @@ -1,11 +1,8 @@ --- title: Use Cases --- -# Use Cases -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/build-times.md b/use-cases/build-times.md index e2c9dbd..ac3d510 100644 --- a/use-cases/build-times.md +++ b/use-cases/build-times.md @@ -1,6 +1,5 @@ --- title: Build Times --- -# Build Times Build (and compile) times are one of the slowest parts of the software development lifecyle (SDLC), usually only faster than the time to run tests. diff --git a/use-cases/cde.md b/use-cases/cde.md index a3fba6e..54d1c6b 100644 --- a/use-cases/cde.md +++ b/use-cases/cde.md @@ -1,11 +1,8 @@ --- title: Cloud Development Environment (CDE --- -# Cloud Development Environment (CDE -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/connectivity.md b/use-cases/connectivity.md index ecd9c4b..9f03e82 100644 --- a/use-cases/connectivity.md +++ b/use-cases/connectivity.md @@ -1,11 +1,8 @@ --- title: Network Connectivity --- -# Network Connectivity -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/dxi.md b/use-cases/dxi.md index 82353a4..9365cd6 100644 --- a/use-cases/dxi.md +++ b/use-cases/dxi.md @@ -1,11 +1,8 @@ --- title: Developer Experience Infrastructure (DXI --- -# Developer Experience Infrastructure (DXI -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/ephemeral-kubernetes-cluster.md b/use-cases/ephemeral-kubernetes-cluster.md index aa4735b..60cf3e2 100644 --- a/use-cases/ephemeral-kubernetes-cluster.md +++ b/use-cases/ephemeral-kubernetes-cluster.md @@ -1,11 +1,8 @@ --- title: Ephemeral Kubernetes Cluster --- -# Ephemeral Kubernetes Cluster -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** DevZero's workspaces are backed by ephemeral, virtualized Kubernetes clusters. Depending on the service tier and/or deployment models that you are being served from, one of the following will apply: diff --git a/use-cases/faster-onboarding.md b/use-cases/faster-onboarding.md index dbdd07f..00b2b82 100644 --- a/use-cases/faster-onboarding.md +++ b/use-cases/faster-onboarding.md @@ -1,11 +1,8 @@ --- title: Faster Onboarding --- -# Faster Onboarding -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/idp.md b/use-cases/idp.md index 5bc5073..78f1452 100644 --- a/use-cases/idp.md +++ b/use-cases/idp.md @@ -1,11 +1,8 @@ --- title: Internal Developer Platform (IDP --- -# Internal Developer Platform (IDP -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/namespaced-cloud-services.md b/use-cases/namespaced-cloud-services.md index 68de6e9..e5ff0c0 100644 --- a/use-cases/namespaced-cloud-services.md +++ b/use-cases/namespaced-cloud-services.md @@ -1,11 +1,8 @@ --- title: Namespaced Cloud Services --- -# Namespaced Cloud Services -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/preview-env.md b/use-cases/preview-env.md index 2b732e4..81d60fb 100644 --- a/use-cases/preview-env.md +++ b/use-cases/preview-env.md @@ -1,11 +1,8 @@ --- title: Preview Environments --- -# Preview Environments -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/sharing-build-caches.md b/use-cases/sharing-build-caches.md index 479a161..8d124e0 100644 --- a/use-cases/sharing-build-caches.md +++ b/use-cases/sharing-build-caches.md @@ -1,11 +1,8 @@ --- title: Sharing Build Caches --- -# Sharing Build Caches -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/standardized-dev-env.md b/use-cases/standardized-dev-env.md index 9ce2540..c4e3c1e 100644 --- a/use-cases/standardized-dev-env.md +++ b/use-cases/standardized-dev-env.md @@ -1,11 +1,8 @@ --- title: Standardized Development Environments --- -# Standardized Development Environments -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/use-cases/testing-env.md b/use-cases/testing-env.md index 6054051..7c3bed8 100644 --- a/use-cases/testing-env.md +++ b/use-cases/testing-env.md @@ -1,11 +1,8 @@ --- title: Testing Environments --- -# Testing Environments -{% hint style="info" %} -**Coming soon...** -{% endhint %} +> **Coming soon...** * Reduce build and compile times * Ensure consistency of development environments diff --git a/workspaces/access.md b/workspaces/access.md index 84611b6..10fa46b 100644 --- a/workspaces/access.md +++ b/workspaces/access.md @@ -1,18 +1,15 @@ --- title: Accessing the DevBox --- -# Accessing the DevBox There are various ways to interact with your DevBox. The first step is to verify the name of the workspace that you want to interact with. If you prefer video from, [click here](access.md#tutorial-video) for a 7min video! -{% code %} ``` # to get the workspace name dz workspace list ``` -{% endcode %} You will see something like this... @@ -30,4 +27,4 @@ To view running applications, visit `:` in your browser (mo Here's a video covering all these concepts: -{% embed url="https://devzero.b-cdn.net/Accessing%20a%20workspace.mp4" %} +[![Accessing a workspace](https://devzero.b-cdn.net/Accessing%20a%20workspace.mp4)](https://devzero.b-cdn.net/Accessing%20a%20workspace.mp4) diff --git a/workspaces/kubernetes-cluster.md b/workspaces/kubernetes-cluster.md index 75322c3..7017029 100644 --- a/workspaces/kubernetes-cluster.md +++ b/workspaces/kubernetes-cluster.md @@ -1,7 +1,6 @@ --- title: Workspace Cluster --- -# Workspace Cluster User workspaces are deploying with an [ephemeral, namespaced Kubernetes cluster](../references/terminology.md#workspace-cluster). If you need to interact with this cluster... @@ -40,9 +39,7 @@ In a fresh new workspace, you can immediately run: kubectl get pods ``` -{% hint style="warning" %} -DevZero reserves the `default` namespace for it's managed deployments. **Do not** operate on this namespace. Adding or removing resources in this namespace will lead to undocumented behaviors and cause potential data loss. -{% endhint %} +> DevZero reserves the `default` namespace for it's managed deployments. **Do not** operate on this namespace. Adding or removing resources in this namespace will lead to undocumented behaviors and cause potential data loss. ``` dz workspace kubeconfig -h @@ -67,7 +64,7 @@ Global Flags: Here's a video covering how you can access and deploy apps to your workspace's Kubernetes cluster... -{% embed url="https://devzero.b-cdn.net/Kubernetes%20demo.mp4" %} +[![Kubernetes Demo](https://devzero.b-cdn.net/Kubernetes%20demo.mp4)](https://devzero.b-cdn.net/Kubernetes%20demo.mp4)
@@ -79,7 +76,6 @@ Here's a video covering how you can access and deploy apps to your workspace's K 2. Use the following recipe, then `Save and Build` and then `Publish` once the build completes successfully (it uses Google Cloud Platform's [`microservices-demo`](https://github.com/GoogleCloudPlatform/microservices-demo) repo). -{% code lineNumbers="true" %} ```yaml version: "3" build: @@ -110,7 +106,6 @@ build: systemctl enable containerd.service user: root ``` -{% endcode %} 3. Build a workspace from the recipe, and run the following in your terminal: diff --git a/workspaces/overview.md b/workspaces/overview.md index eea31a4..1aabe27 100644 --- a/workspaces/overview.md +++ b/workspaces/overview.md @@ -1,7 +1,6 @@ --- title: Overview --- -# Overview ## What is a Workspace diff --git a/workspaces/regions/README.md b/workspaces/regions/README.md index e025691..dc0a611 100644 --- a/workspaces/regions/README.md +++ b/workspaces/regions/README.md @@ -1,7 +1,6 @@ --- title: Regions --- -# Regions Workspaces can be launched in any supported DevZero region, provided your team and subscription tier allow for it. When you sign-up for DevZero, you have a default region set. You can change this preference from your [user settings page](https://www.devzero.io/dashboard/settings/user-settings). diff --git a/workspaces/regions/supported-regions.md b/workspaces/regions/supported-regions.md index 8310f22..d28bf3a 100644 --- a/workspaces/regions/supported-regions.md +++ b/workspaces/regions/supported-regions.md @@ -3,7 +3,6 @@ description: Edge compute regions supported by the hosted DevZero platform title: Supported Regions --- -# Supported Regions
diff --git a/workspaces/stop-pause-resume.md b/workspaces/stop-pause-resume.md index c3f8f11..28abceb 100644 --- a/workspaces/stop-pause-resume.md +++ b/workspaces/stop-pause-resume.md @@ -1,18 +1,12 @@ --- title: Workspace Lifecycle --- -# Workspace Lifecycle Workspaces are be hibernated when inactivity is detected (or when the DevZero platform under conditions of duress). Currently, all the contents under `/home/devzero` are backed by a persistent volume. :rotating\_light: Therefore, contents outside of `/home/devzero` (for example, `/var/*`, `/tmp/*`, etc) **will be lost** when such an event occurs. -{% hint style="info" %} -**On the roadmap...** Our team is actively working on ways to preserve and restore: - -* running process -* state of the entire filesystem for when a workspace or any of its parts are restarted after being paused/stopped. -{% endhint %} +> **On the roadmap...** Our team is actively working on ways to preserve and restore: running processes and state of the entire filesystem for when a workspace or any of its parts are restarted after being paused/stopped. Users cannot manually hibernate a workspace, however they are automatically restarted (if in a hibernated state) when you attempt to reconnect to the workspace.