-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add demo guides for Coder, JupyterHub, PostgreSQL, and LLM Mode… #60
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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| --- | ||
| title: Coder Demo | ||
| description: Deploy Coder for cloud-based VS Code IDE environments with support for both Go and Python backends. | ||
| --- | ||
|
|
||
| import { Steps, Aside, LinkCard } from '@astrojs/starlight/components'; | ||
|
|
||
| This guide demonstrates how to deploy Coder to provide cloud-based VS Code IDE environments for development and coding. | ||
|
|
||
| ## Deploy Coder | ||
|
|
||
| <Aside type="tip"> | ||
| Coder provides a cloud-based VS Code IDE that can be accessed through a web browser. It supports multiple backend options including Go and Python versions, making it suitable for various development workflows. | ||
| </Aside> | ||
|
|
||
| <Steps> | ||
|
|
||
| 1. Navigate to the Applications Store: | ||
|
|
||
| Open your browser and go to: | ||
| ``` | ||
| <url>/scope/<scope-name>/applications/store | ||
| ``` | ||
|
|
||
| 2. Search and install Coder: | ||
|
|
||
| - Search for `code-server` (available versions: `code-server-go` or `code-server-python`) | ||
| - Choose your preferred version (Go for better performance, Python for flexibility) | ||
| - Click on the Coder card | ||
| - Click the **Install** button and follow the installation wizard | ||
| - Review and confirm the Helm Chart configuration | ||
|
|
||
| 3. Verify the deployment: | ||
|
|
||
| Go to the Workloads page: | ||
| ``` | ||
| <url>/scope/<scope-name>/applications/workloads | ||
| ``` | ||
|
|
||
| - Use the **Namespace** filter to find the deployment | ||
| - Search for `coder` or `code-server` to locate the deployed Coder workload | ||
| - Verify that the workload status shows as running | ||
|
|
||
| 4. Access Coder VS Code IDE: | ||
|
|
||
| - In the Workloads list, locate the Coder workload | ||
| - Click on the **NodePort** link to open VS Code in your browser | ||
|
|
||
| <Aside type="tip" title="Default Credentials"> | ||
| Access the VS Code IDE directly through the NodePort link. Once opened, you can start coding immediately. Authentication and access control are managed through the application deployment settings. | ||
| </Aside> | ||
|
|
||
| </Steps> | ||
|
|
||
| ## Initial Setup | ||
|
|
||
| Once Coder is deployed and running: | ||
|
|
||
| 1. Access the VS Code IDE through the NodePort link in your browser | ||
| 2. You'll see the VS Code interface with a file explorer and terminal | ||
| 3. Start creating or editing files directly in the browser-based editor | ||
| 4. Use the integrated terminal for running commands and development tasks | ||
|
|
||
| ## Next Steps | ||
|
|
||
| Explore other demo applications to enhance your infrastructure: | ||
|
|
||
| <LinkCard title="PostgreSQL Demo" href="/demos/03-postgres/" description="Learn how to deploy PostgreSQL database and test read/write operations with Python." /> | ||
|
|
||
| <LinkCard title="LLM Model Demo" href="/demos/04-llm-model/" description="Learn how to deploy and configure language model applications." /> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| --- | ||
| title: JupyterHub Demo | ||
| description: Deploy JupyterHub for multi-user Jupyter notebook environments. | ||
| --- | ||
|
|
||
| import { Steps, Aside, LinkCard } from '@astrojs/starlight/components'; | ||
|
|
||
| This guide demonstrates how to deploy JupyterHub to provide collaborative Jupyter notebook environments for multiple users. | ||
|
|
||
| ## Deploy JupyterHub | ||
|
|
||
| <Aside type="tip"> | ||
| JupyterHub provides a multi-user environment where multiple users can access Jupyter notebooks simultaneously, making it ideal for collaborative data science and educational purposes. | ||
| </Aside> | ||
|
|
||
| <Steps> | ||
|
|
||
| 1. Navigate to the Applications Store: | ||
|
|
||
| Open your browser and go to: | ||
| ``` | ||
| <url>/scope/<scope-name>/applications/store | ||
| ``` | ||
|
|
||
| 2. Search and install JupyterHub: | ||
|
|
||
| - Search for `jupyterhub` | ||
| - Click on the JupyterHub card | ||
| - Click the **Install** button and follow the installation wizard | ||
| - Review and confirm the Helm Chart configuration | ||
|
|
||
| 3. Verify the deployment: | ||
|
|
||
| Go to the Workloads page: | ||
| ``` | ||
| <url>/scope/<scope-name>/applications/workloads | ||
| ``` | ||
|
|
||
| - Use the **Namespace** filter to find the deployment | ||
| - Search for `jupyterhub` to locate the deployed JupyterHub workload | ||
| - Verify that the workload status shows as running | ||
|
|
||
| 4. Access JupyterHub: | ||
|
|
||
| - In the same Workloads list, locate the workload named **proxy** | ||
| - Click on the **NodePort** link to open JupyterHub in your browser | ||
|
|
||
| <Aside type="tip" title="Default Credentials"> | ||
| The default login credentials are: | ||
| - **Username**: `admin` | ||
| - **Password**: `admin` | ||
|
|
||
| For production environments, it's highly recommended to change these credentials through JupyterHub administration settings. | ||
| </Aside> | ||
|
|
||
| </Steps> | ||
|
|
||
| ## Initial Setup | ||
|
|
||
| Once JupyterHub is deployed and running: | ||
|
|
||
| 1. Access the JupyterHub login page | ||
| 2. Create or log in with your credentials | ||
| 3. Start a new notebook server | ||
| 4. Begin using Jupyter notebooks for data analysis and development | ||
|
|
||
| ## Next Steps | ||
|
|
||
| Explore other demo applications to enhance your infrastructure: | ||
|
|
||
| <LinkCard title="PostgreSQL Demo" href="/demos/03-postgres/" description="Learn how to deploy PostgreSQL database and test read/write operations with Python." /> | ||
|
|
||
| <LinkCard title="LLM Model Demo" href="/demos/04-llm-model/" description="Learn how to deploy and configure language model applications." /> | ||
|
Comment on lines
+71
to
+73
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To improve navigation and maintain consistency across the demo guides, please add a link to the Coder demo in this 'Next Steps' section. Ordering the links numerically would also improve user experience. |
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency and better navigation between the new demo guides, I recommend adding a link to the JupyterHub demo. It's also a good practice to keep these links in a consistent order (e.g., numerical).