opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: adopt markdownlint and markdown-table-formatter for *.md (#15831)

Browse Source 
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
This commit is contained in:
Muhammad Atif Ali
2025-01-03 13:12:59 +00:00
committed by GitHub
co-authored by Edward Angert
parent 08463c27d8
commit 94f5d52fdc
255 changed files with 18279 additions and 16786 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/templates/extending-templates/docker-in-workspaces.md
+1 -1
View File
@@ -3,7 +3,7 @@
There are a few ways to run Docker within container-based Coder workspaces.
| Method | Description | Limitations |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Sysbox container runtime](#sysbox-container-runtime) | Install the Sysbox runtime on your Kubernetes nodes or Docker host(s) for secure docker-in-docker and systemd-in-docker. Works with GKE, EKS, AKS, Docker. | Requires [compatible nodes](https://github.com/nestybox/sysbox#host-requirements). [Limitations](https://github.com/nestybox/sysbox/blob/master/docs/user-guide/limitations.md) |
| [Envbox](#envbox) | A container image with all the packages necessary to run an inner Sysbox container. Removes the need to setup sysbox-runc on your nodes. Works with GKE, EKS, AKS. | Requires running the outer container as privileged (the inner container that acts as the workspace is locked down). Requires compatible [nodes](https://github.com/nestybox/sysbox/blob/master/docs/distro-compat.md#sysbox-distro-compatibility). |
| [Rootless Podman](#rootless-podman) | Run Podman inside Coder workspaces. Does not require a custom runtime or privileged containers. Works with GKE, EKS, AKS, RKE, OpenShift | Requires smarter-device-manager for FUSE mounts. [See all](https://github.com/containers/podman/blob/main/rootless.md#shortcomings-of-rootless-podman) |
docs/admin/templates/extending-templates/external-auth.md
+1 -1
View File
@@ -52,7 +52,7 @@ coder external-auth access-token <external-auth-id>
Note: Some IDE's override the `GIT_ASKPASS` environment variable and need to be
configured.
**VSCode**
#### VSCode
Use the
[Coder](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote)
docs/admin/templates/extending-templates/parameters.md
+1 -1
View File
@@ -90,7 +90,7 @@ data "coder_parameter" "security_groups" {
> For the above example, to override the default values of the `security_groups`
> parameter, you will need to pass the following argument to `coder create`:
>
> ```
> ```shell
> --parameter "\"security_groups=[\"\"DevOps Security Group\"\",\"\"Backend Security Group\"\"]\""
> ```
>
docs/admin/templates/extending-templates/process-logging.md
+22 -22
View File
@@ -254,28 +254,28 @@ The raw logs will look something like this:
```json
{
"ts": "2022-02-28T20:29:38.038452202Z",
"level": "INFO",
"msg": "exec",
"fields": {
"labels": {
"user_email": "jessie@coder.com",
"user_id": "5e876e9a-121663f01ebd1522060d5270",
"username": "jessie",
"workspace_id": "621d2e52-a6987ef6c56210058ee2593c",
"workspace_name": "main"
},
"cmdline": "uname -a",
"event": {
"filename": "/usr/bin/uname",
"argv": ["uname", "-a"],
"truncated": false,
"pid": 920684,
"uid": 101000,
"gid": 101000,
"comm": "bash"
}
}
"ts": "2022-02-28T20:29:38.038452202Z",
"level": "INFO",
"msg": "exec",
"fields": {
"labels": {
"user_email": "jessie@coder.com",
"user_id": "5e876e9a-121663f01ebd1522060d5270",
"username": "jessie",
"workspace_id": "621d2e52-a6987ef6c56210058ee2593c",
"workspace_name": "main"
},
"cmdline": "uname -a",
"event": {
"filename": "/usr/bin/uname",
"argv": ["uname", "-a"],
"truncated": false,
"pid": 920684,
"uid": 101000,
"gid": 101000,
"comm": "bash"
}
}
}
```
docs/admin/templates/extending-templates/variables.md
+7 -7
View File
@@ -53,15 +53,15 @@ variables, you can employ a straightforward solution:
1. Create a `terraform.tfvars` file in in the template directory:
```tf
coder_image = newimage:tag
```
```tf
coder_image = newimage:tag
```
2. Push the new template revision using Coder CLI:
1. Push the new template revision using Coder CLI:
```
coder templates push my-template -y # no need to use --var
```
```shell
coder templates push my-template -y # no need to use --var
```
This file serves as a mechanism to override the template settings for variables.
It can be stored in the repository for easy access and reference. Coder CLI
docs/admin/templates/extending-templates/workspace-tags.md
+5 -5
View File
@@ -26,7 +26,7 @@ data "coder_workspace_tags" "custom_workspace_tags" {
}
```
**Legend**
### Legend
- `zone` - static tag value set to `developers`
- `runtime` - supported by the string-type `coder_parameter` to select
@@ -55,7 +55,7 @@ raw values from the database and evaluates them using provided template
variables and parameters. This is illustrated in the table below:
| Value Type | Template Import | Workspace Creation |
| ---------- | -------------------------------------------------- | ----------------------- |
|------------|----------------------------------------------------|-------------------------|
| Static | `{"region": "us"}` | `{"region": "us"}` |
| Variable | `{"az": var.az}` | `{"region": "us-east"}` |
| Parameter | `{"cluster": data.coder_parameter.cluster.value }` | `{"cluster": "dev"}` |
@@ -98,7 +98,7 @@ as immutable and set only once, during workspace creation.
You may only specify the following as inputs for `coder_workspace_tags`:
| | Example |
| :----------------- | :-------------------------------------------- |
|:-------------------|:----------------------------------------------|
| Static values | `"developers"` |
| Template variables | `var.az` |
| Coder parameters | `data.coder_parameter.runtime_selector.value` |
@@ -115,7 +115,7 @@ raw queries on-the-fly without processing the entire Terraform template. This
evaluation is simpler but also limited in terms of available functions,
variables, and references to other resources.
**Supported syntax**
#### Supported syntax
- Static string: `foobar_tag = "foobaz"`
- Formatted string: `foobar_tag = "foobaz ${data.coder_parameter.foobaz.value}"`
@@ -125,7 +125,7 @@ variables, and references to other resources.
- Condition:
`cache = data.coder_parameter.feature_cache_enabled.value == "true" ? "with-cache" : "no-cache"`
**Not supported**
#### Not supported
- Function calls: `try(var.foo, "default")`
- Resources: `compute_instance.dev.name`
docs/admin/templates/managing-templates/devcontainers/add-devcontainer.md
+1 -5
View File
@@ -121,7 +121,7 @@ their development environments:
## Example templates
| Template | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/docker-devcontainer) | Docker provisions a development container. |
| [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-devcontainer) | Provisions a development container on the Kubernetes cluster. |
| [Google Compute Engine dev container](https://github.com/coder/coder/tree/main/examples/templates/gcp-devcontainer) | Runs a development container inside a single GCP instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace. |
@@ -144,7 +144,3 @@ Lifecycle scripts are managed by project developers.
## Next steps
- [Dev container security and caching](./devcontainer-security-caching.md)
```
```
docs/admin/templates/managing-templates/devcontainers/devcontainer-security-caching.md
+1 -1
View File
@@ -3,7 +3,7 @@
Ensure Envbuilder can only pull pre-approved images and artifacts by configuring
it with your existing HTTP proxies, firewalls, and artifact managers.
### Configure registry authentication
## Configure registry authentication
You may need to authenticate to your container registry, such as Artifactory, or
Git provider such as GitLab, to use Envbuilder. See the