> For the complete documentation index, see [llms.txt](https://cleyrop.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cleyrop.gitbook.io/docs/documentation-fr-en/the-factory/devspace.md). # DevSpace ## Understanding the DevSpace The DevSpace is a personal development environment hosted on the Cleyrop platform. It gives you an isolated, standardized, and persistent workspace, accessible from anywhere via SSH. Designed for developers, the DevSpace solves common issues related to local environments: heterogeneous configurations, difficulty reproducing bugs, and no access to Cleyrop internal resources. ### What is a DevSpace? A DevSpace is an Ubuntu 24.04 container provisioned on demand. Each user has a single personal DevSpace with the following characteristics * Controlled resources: choose the CPU/RAM combination and storage size at creation time * Persistent storage: your files in /home/cleyrop are kept between stops and restarts. * SSH access: connect from your preferred IDE (VS Code, IntelliJ, PyCharm). * Access to Cleyrop resources: secure connection to Apps, Datasets, AI Gen Proxy, Corpus, and Work Data * Lifecycle management: start, stop, and delete on demand. {% hint style="warning" %} Regarding persistent storage: * As of now, it is not possible to increase the storage of your DevSpace. * Only the /home/cleyrop folder is persistent. Any file stored elsewhere will be lost when the DevSpace stops. {% endhint %} ## Manage your DevSpace ### Create your DevSpace Provision your personal development environment in just a few clicks. 1. Click on DevSpace in the main navigation menu 2. If you do not already have a DevSpace, click on :gear: Configure 3. Check your **device SSH key** : the system automatically checks whether a key is configured in your profile. If not, click “Add a key” and follow the tutorial. 4. Choose the **resources** : select a CPU/RAM combination from the available options or enter custom values 5. Define the **storage** : choose the size of the persistent volume. This value cannot be changed later. 6. Select the **Accessible Apps** (optional): by default, no app is accessible. Use the search bar and filters to select the Apps you need. 7. Click Configure. Provisioning the DevSpace usually takes a few seconds. The status changes from “Starting” to “Running” when the environment is ready. {% hint style="info" %} ✓ Use Ed25519 keys for optimal security. ✓ Configure the \~/.ssh/config file to avoid retyping the settings for every connection. ✓ Never share your private key ✓ Manage the SSH keys allowed to access your DevSpace from your Personal Space > SSH Key {% endhint %} {% hint style="success" %} Size the resources according to your actual needs to avoid overloading the cluster. {% endhint %}
### Manage app access Configure the apps your DevSpace can connect to at the network level. By default, your DevSpace has access to no apps. You must explicitly select the apps you need to follow the principle of network least privilege. This configuration can be changed at any time, even when the DevSpace is running. From the Apps tab of your DevSpace, you can add or remove the apps you want to access from your DevSpace.
### Manage used resources Monitor the state of your environment to optimize resource usage. You can start, stop, or change the resources of your DevSpace at any time. Stopping releases the CPU and RAM resources while keeping your data in persistent storage. #### Adjust resources From the detail page, click on :gear: to change the CPU/RAM resources. Validating the change requires an automatic redeployment of the DevSpace. #### Start the DevSpace From your DevSpace detail page, click on :play: * The status changes to “Starting” and then “Running” after a few seconds. If there is a problem, you can view the logs from your DevSpace details by clicking the Log button. #### Stop the DevSpace From your DevSpace detail page, click on :stop: {% hint style="warning" %} Make sure you have saved your work before stopping. Files outside /home/cleyrop will be lost. {% endhint %} After a stop/start cycle, you will find: * All your files in /home/cleyrop * Your Python packages installed with UV * Your user configurations (.bashrc, .gitconfig, etc.) * Your cloned Git repositories * Your bash command history #### Delete the DevSpace Deleting your DevSpace is irreversible and results in the permanent loss of all your data, including data stored in /home/cleyrop. 1. From your DevSpace detail page, click on **Delete** 2. Confirm deletion {% hint style="warning" %} Back up all your files before deleting your DevSpace. This action is irreversible. {% endhint %} ## Use your DevSpace Your DevSpace is accessible via SSH from all IDEs that support remote connections. You will find all usage guides and tutorials directly from the DevSpace details. ### Connect to an IDE You can connect to **VS Code IDE**, **JetBrains** or a **Terminal** by creating a secure SSH tunnel. Follow the steps to configure and launch the SSH connection.
### Troubleshoot SSH connection issues If the connection to your DevSpace is unstable or frequently drops, replace the `ProxyCommand` in `~/.ssh/config` with the following command using `socat` : ```bash ProxyCommand socat - OPENSSL:%h:%p,verify=0 ``` Example of a complete block in `~/.ssh/config` : ```bash Host cleyrop-devspace HostName User cleyrop Port 2222 IdentityFile ProxyCommand socat - OPENSSL:%h:%p,verify=0 # optional, improve stability ServerAliveInterval 15 ServerAliveCountMax 3 TCPKeepAlive yes ``` To test directly from the command line without modifying the configuration file: ```bash ssh -p 2222 -o ProxyCommand="socat - OPENSSL:%h:%p,verify=0" cleyrop@ ``` **On macOS with LibreSSL** On macOS, `openssl` points by default to LibreSSL, which does not support `-ign_eof` and causes TLS interruptions about every 2 minutes. Install OpenSSL via Homebrew and use: ```bash ProxyCommand openssl s_client -quiet -ign_eof -connect %h:%p -servername %h ``` ### Manage Python packages with UV Install and manage your Python dependencies with UV, the built-in package manager. Your DevSpace includes UV, a modern and high-performance Python package manager. All packages installed in /home/cleyrop are persistent. #### Create a virtual environment (recommended) 1. Create a folder for your project: `cd /home/cleyrop/projects/my-project` 2. Create the virtual environment:\ `uv venv` 3. Activate the environment:\ `source .venv/bin/activate`.\ The prompt displays (.venv) to confirm activation. #### Manage packages You will find your packages: * With virtual environment: /home/cleyrop/projects/my-project/.venv/ (project-isolated) * Without virtual environment: /home/cleyrop/.local/ (global) Both locations are persistent between DevSpace restarts. **Common UV commands**
ActionCommand
Install packagesuv pip install pandas numpy
Install from requirements.txtuv pip install -r requirements.txt
List installed packagesuv pip list
Update a packageuv pip install --upgrade pandas
Generate requirements.txtuv pip freeze > requirements.txt
{% hint style="success" %} ✓ Always create a virtual environment per project. ✓ Keep an up-to-date requirements.txt file for each project. ✓ Add .venv/ to .gitignore (never version the environment). ✓ Never use sudo (you do not have root privileges). {% endhint %} ### Clone Git repositories To clone private repositories, you must add the public SSH key of your DevSpace as a Deploy Key on your repositories. Each DevSpace has its own key. #### Retrieve the DevSpace public key In the Information tab of your DevSpace, click Copy SSH key. #### Add the Deploy Key on GitHub/GitLab 1. Go to your repository. 2. Go to Settings > Deploy keys > Add deploy key. 3. Paste the DevSpace public key. 4. Check *Allow write access* if you want to be able to push. 5. Save. #### Clone the repository ```bash # Create the working folder mkdir -p /home/cleyrop/projects cd /home/cleyrop/projects # Clone from GitHub git clone git@github.com:/.git # Clone from GitLab git clone git@gitlab.com:/.git ``` ### Access Cleyrop resources Your DevSpace can access the internal resources of the Cleyrop platform, provided the appropriate access has been configured. #### Available resources • AI Gen Proxy: access to generative AI models via the py-ai-cleyrop SDK • Datasets: read and write data (via the datasets API) • Apps: depending on your configuration. #### Technical documentation To use the library in your Python code, refer to the PyAI Cleyrop documentation, which details the most up-to-date access methods. *** ## Best practices * Stop your DevSpace when you are not using it to free up cluster resources * Store all your work in /home/cleyrop to ensure persistence. * Allow only the apps you truly need (least-privilege principle). * Always create a virtual environment per project and keep an up-to-date requirements.txt file for each project.