Reusable Template for SDS Workspace Onboarding
Overview
Use this template to onboard developers to Citrix Secure Developer Spaces (SDS). This framework provides a concise, step-by-step guide to move from initial access to a running application. You can customize and extend this document with your specific tools, repositories, and policies to deliver a consistent, personalized onboarding experience for your team.
Before you begin
Before starting, ensure that one of the following is available:
- A workspace template shared by your IT team or team lead via link or accessible via the SDS UI.
- Access to the default SDS template from the workspace.
If neither is available, contact your team lead before proceeding.
Step 1: Configure your profile and launch a workspace
Administrator Note: In this phase, users will configure their profiles in the SDS UI to quickly access, build, and run an application. The environment uses a standard Linux terminal and Visual Studio Code. The objective is to run the existing application in the new environment as soon as possible to establish familiar practices.
1. Set up your profile
- Log in to the SDS Application UI.
- In your profile,
- Set your time zone and preferred work schedule.
- Authenticate with your Git provider (GitHub, GitLab, or Bitbucket).
2. Launch your workspace
Choose one of the following options:
- Option A: From the SDS UI, select the arrow next to Create Workspace, and then select From Template. Select a workspace template, and then select Launch.
- Option B: If your Git repository has a file with a Workspace link (typically readme.md), click Open Workspace directly from the project’s README.md.
3. Clone and build your project
- Open the workspace using the browser-based VS Code interface or terminal.
- Clone your repository using your standard git clone command.
- Run your usual build commands.
- Check that the VS Code extension for SDS is installed and active. This extension allows you to open and manage applications running on your workspace.
- Use the extension to run your application and preview the application using the URL.
You are done with Step 1 when your application is running and accessible via a live URL.
Step 2: Set up quick access
Administrator Note: In this phase, users set up their preferred method for accessing a workspace: either from a desktop icon, via a progressive Web app, or using a URL embedded in a web or markdown page. The latter is typically used to start a workspace from a Git repository.
1. Create a desktop shortcut to your workspace (open from the IDE or Terminal)
Create a desktop or taskbar shortcut to:
- The SDS UI, or
- A specific workspace.
This allows instant access without navigating bookmarks or the SDS UI.
2. Enable Git repository start-up
On the Workspace page, under Template, copy the Quick Start template link to add an Open Workspace icon to your repository’s README.md, making it easy to launch SDS directly from the repo.
Step 3: Customize your profile settings
Administrator Note: In this phase, users explore workspace customization options. They can configure environments in the SDS UI via the user profile menu or by editing the workspace configuration.
1. Persist shell configuration
Using the profile menu, add your .bashrc or .zshrc files so that they will be automatically added to your home directory when a new workspace is created. You can update an existing workspace using the update option from the workspace menu.
2. Add secrets and keys
Your profile also lets you define variables (e.g., with secrets) and generate an SSH key to be available in your workspace:
- Personal environment variables
- SSH keys – allow you to ssh to a host using a private key stored in the credentials proxy.
These settings can be updated at any time.
3. Preload VS Code extensions
Using the profile menu, configure your preferred VS Code extensions to be automatically available when the workspace launches.
Step 4: (Optional) Customize your Workspace settings
Administrator Note: In this phase, users modify their workspace configuration to optimize performance and automate repetitive tasks.
1. Adjust hardware resources
Update CPU and memory settings based on project needs, such as large builds or resource-intensive tooling. These settings can be changed at any time.
2. Automate workspace startup
Using the workspace editor, add pre- or post-startup scripts to automatically install tools or dependencies when the workspace starts. This option adds tools to an existing base image that cannot be installed in the home folder (./home/developer). To learn more about how data is persisted across reboots, see Maintain persistent changes in your workspace.
3. Configure autorun
Using the workspace editor, you can set application running on your workspace to start automatically at boot time.
Getting help
If your workspace fails to start, your build does not complete, or your application does not run as expected, contact your team lead or the SDS support channel.