Skip to content

chore: 2 minor clarifications around features #1155

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 21, 2022
Merged

chore: 2 minor clarifications around features #1155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c69914
chore: 2 minor clarifications around features
bpmct Oct 21, 2022
b7ebf34
lint
bpmct Oct 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions admin/git.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,17 @@ When done, click **Save**.
> - name: CODERD_BITBUCKET_CONSUMER_KEY
> value: ""
> ```

### Built-in GitHub Integration (VS Code)

Alternatively, users can VS Code's
[built-in GitHub integration](https://code.visualstudio.com/docs/sourcecontrol/github)
in order to clone repositories within VS Code Remote and code-server. This uses
a GitHub token to authenticate instead of SSH keys.

To cache the token within the workspace, users can run the following command.
This can also be added to a [configure script](../images/configure.md):

```sh
git config --global credential.helper store
```
7 changes: 2 additions & 5 deletions setup/scaling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,5 @@ ensuring sufficient resources and response time.

### Horizontal Pod Autoscaling

Horizontal Pod Autoscaling (HPA) is another Kubernetes technique to
automatically add, and remove, additional `coderd` pods when the existing pods
exceed sustained CPU and memory thresholds. Consult
[Kubernetes HPA documentation](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
for the various API version implementations of HPA.
We do not recommend using [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
with Coder. In some environments, this will lead to errors with workspace builds.
25 changes: 13 additions & 12 deletions workspaces/editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ from your local VS Code, connected to your Coder workspace for compute, etc.
> `remote.SSH.allowLocalServerDownload` enabled so the extension will install
> the VS Code Server on the client first and then copy it over to the Coder
> workspace via SCP.
>
> For further troubleshooting steps, see [Troubleshooting hanging or failing
> connections](https://code.visualstudio.com/docs/remote/troubleshooting#_troubleshooting-hanging-or-failing-connections)
>
> For further troubleshooting steps, see
> [Troubleshooting hanging or failing connections](https://code.visualstudio.com/docs/remote/troubleshooting#_troubleshooting-hanging-or-failing-connections)

![VS Code Remote Explorer](../assets/workspaces/vscode-remote-ssh-panel.png)

Expand Down Expand Up @@ -328,8 +328,8 @@ for setting up your custom image and configure script.

Jupyter Notebook is the original web IDE for creating Notebooks used in data
science, machine learning and analytics projects. By default, any Coder
workspace with the Jupyter project installed (in `/usr/local/bin/jupyter`)
will render the icon to launch Jupyter Notebook.
workspace with the Jupyter project installed (in `/usr/local/bin/jupyter`) will
render the icon to launch Jupyter Notebook.

![Jupyter Notework](../assets/workspaces/jupyter-notebook-icon.png)

Expand Down Expand Up @@ -378,8 +378,9 @@ RUN chmod +x jupyter
USER coder
```

Below is an example `jupyter` script with the lab arguments. This file must
be located in the same directory as the Dockerfile to be copied during `docker build`
Below is an example `jupyter` script with the lab arguments. This file must be
located in the same directory as the Dockerfile to be copied during
`docker build`

```sh
#!/bin/bash
Expand All @@ -391,10 +392,10 @@ args=${args/notebook/"lab"}
jupyter.py ${args}
```

The second method to run JupyterLab is with a dev URL and launching
JupyterLab via `supervisord` in the `configure` script. The benefit of this
approach is it is completely independent of Coder's IDE launching mechanism
and relies only on a generic dev URL.
The second method to run JupyterLab is with a dev URL and launching JupyterLab
via `supervisord` in the `configure` script. The benefit of this approach is it
is completely independent of Coder's IDE launching mechanism and relies only on
a generic dev URL.

![JupyterLab as a dev URL](../assets/workspaces/jupyterlab-as-devurl.png)

Expand Down Expand Up @@ -448,7 +449,7 @@ directory=/home/coder
The third method to access JupyterLab is locally using the SSH port forward
command: `ssh -L 8888:localhost:8888 coder.jupyterlab`. Alternatively, you can
use the Coder CLI to port forward using: `coder tunnel jupyterlab 8888 8888`.
Now, open a local browser and navigate to `https://localhost:8888`.
Now, open a local browser and navigate to `https://localhost:8888`.

## RStudio

Expand Down