Web IDE runbook
Basic information
Section titled “Basic information”Contact
Section titled “Contact”- Group: AI:Editor Extensions: VS Code
- Handbook: Editor Extensions: VS Code
- Group Slack channel: #g_editor-extensions
- Feature Slack channel: #f_vscode_web_ide
Availability
Section titled “Availability”- gitlab.com, dedicated, and self-managed instances.
- Available on free-tier with the exception of AI-related capabilities.
Core Functionality
Section titled “Core Functionality”- Source control: Modify one or more files in a local repository, commit, and push them to the remote repository.
- Extensions Marketplace: Install 3rd-party extensions to extend the core functionality of the editor.
- Integration with Duo Code Suggestions and Duo Chat.
- Markdown preview.
Documentation
Section titled “Documentation”- User documentation
- Troubleshooting instructions
- Extension host domain configuration
- Extension marketplace configuration
- Development documentation
Dashboards
Section titled “Dashboards”- Web IDE HTTP requests logs
- .cdn.web-ide.gitlab-static.net health dashboard
- Editor Extensions error budget dashboard
- Web IDE sentry errors dashboard
- Tableau usage dashboard.
- Use the Open VSX status page to check the status of the Open VSX service that provides 3rd-party extensions to the Web IDE.
Troubleshooting and incident mitigation
Section titled “Troubleshooting and incident mitigation”If the Web IDE doesn’t load
Section titled “If the Web IDE doesn’t load”- Check the health of the
.cdn.web-ide.gitlab-static.netservice and the error budget Web IDE rails controllers. You can find links to all dashboards in the dashboards section. - Check client-side errors in the Sentry dashboard.
Reach out to the infrastructure platforms team assistance
to recover .cdn.web-ide.gitlab-static.net.
Customers experience CORS issues
Section titled “Customers experience CORS issues”You can find information about common CORS issues for the Web IDE in the user documentation.
Rollback procedure
Section titled “Rollback procedure”To revert the Web IDE editor version, Submit an MR reverting the @gitlab/web-ide npm package update in the GitLab Application package.json
file.
Extensions Marketplace
Section titled “Extensions Marketplace”Check the status of the Open VSX extensions registry in the Open VSX status page.
If necessary, we can disable the Extensions Marketplace or change the registry default URL in the gitlab.com admin portal. You can read the instructions in the administration docs.