Jump To Close Expand all Collapse all Table of contents Administration Guide 1. Customizing the devfile and plug-in registries Expand section "1. Customizing the devfile and plug-in registries" Collapse section "1. Customizing the devfile and plug-in registries" 1.1. Building and running a custom registry image Expand section "1.1. Building and running a custom registry image" Collapse section "1.1. Building and running a custom registry image" 1.1.1. Building a custom devfile registry 1.1.2. Building a custom plug-in registry 1.1.3. Deploying the registries Expand section "1.1.3. Deploying the registries" Collapse section "1.1.3. Deploying the registries" 1.1.3.1. Deploying registries in OpenShift 1.1.3.2. Deploying registries in OpenShift 1.2. Including the plug-in binaries in the registry image 1.3. Editing a devfile and plug-in at runtime Expand section "1.3. Editing a devfile and plug-in at runtime" Collapse section "1.3. Editing a devfile and plug-in at runtime" 1.3.1. Adding a plug-in at runtime 1.3.2. Adding a devfile at runtime 2. Retrieving CodeReady Workspaces logs Expand section "2. Retrieving CodeReady Workspaces logs" Collapse section "2. Retrieving CodeReady Workspaces logs" 2.1. Viewing OpenShift events 2.2. Viewing CodeReady Workspaces server logs Expand section "2.2. Viewing CodeReady Workspaces server logs" Collapse section "2.2. Viewing CodeReady Workspaces server logs" 2.2.1. Viewing the CodeReady Workspaces server logs in the web console 2.2.2. Viewing the CodeReady Workspaces server logs on the command line 2.3. Viewing external service logs Expand section "2.3. Viewing external service logs" Collapse section "2.3. Viewing external service logs" 2.3.1. Viewing Keycloak logs Expand section "2.3.1. Viewing Keycloak logs" Collapse section "2.3.1. Viewing Keycloak logs" 2.3.1.1. Viewing the Keycloak server logs 2.3.1.2. Viewing the Keycloak client logs on Firefox 2.3.1.3. Viewing the Keycloak client logs on Google Chrome 2.3.2. Viewing the PostgreSQL server logs 2.4. Viewing workspaces logs Expand section "2.4. Viewing workspaces logs" Collapse section "2.4. Viewing workspaces logs" 2.4.1. Viewing Che-Theia IDE logs Expand section "2.4.1. Viewing Che-Theia IDE logs" Collapse section "2.4.1. Viewing Che-Theia IDE logs" 2.4.1.1. Viewing Che-Theia IDE logs on the command line 2.4.1.2. Viewing Che-Theia IDE logs in the web console 2.4.2. Viewing logs from language servers and debug adapters Expand section "2.4.2. Viewing logs from language servers and debug adapters" Collapse section "2.4.2. Viewing logs from language servers and debug adapters" 2.4.2.1. Checking important logs 2.4.2.2. Detecting memory problems 2.4.2.3. Logging the client-server traffic for debug adapters 2.4.2.4. Viewing logs for Python 2.4.2.5. Viewing logs for Go Expand section "2.4.2.5. Viewing logs for Go" Collapse section "2.4.2.5. Viewing logs for Go" 2.4.2.5.1. Finding the gopath 2.4.2.5.2. Viewing the Debug Console log for Go 2.4.2.5.3. Viewing the Go logs output in the Output panel 2.4.2.6. Viewing logs for the NodeDebug NodeDebug2 adapter 2.4.2.7. Viewing logs for Typescript Expand section "2.4.2.7. Viewing logs for Typescript" Collapse section "2.4.2.7. Viewing logs for Typescript" 2.4.2.7.1. Enabling the label switched protocol (LSP) tracing 2.4.2.7.2. Viewing the Typescript language server log 2.4.2.7.3. Viewing the Typescript logs output in the Output panel 2.4.2.8. Viewing logs for Java Expand section "2.4.2.8. Viewing logs for Java" Collapse section "2.4.2.8. Viewing logs for Java" 2.4.2.8.1. Verifying the state of the Eclipse JDT Language Server 2.4.2.8.2. Verifying the Eclipse JDT Language Server features 2.4.2.8.3. Viewing the Java language server log 2.4.2.8.4. Logging the Java language server protocol (LSP) messages 2.4.2.9. Viewing logs for Intelephense Expand section "2.4.2.9. Viewing logs for Intelephense" Collapse section "2.4.2.9. Viewing logs for Intelephense" 2.4.2.9.1. Logging the Intelephense client-server communication 2.4.2.9.2. Viewing Intelephense events in the Output panel 2.4.2.10. Viewing logs for PHP-Debug 2.4.2.11. Viewing logs for XML Expand section "2.4.2.11. Viewing logs for XML" Collapse section "2.4.2.11. Viewing logs for XML" 2.4.2.11.1. Verifying the state of the XML language server 2.4.2.11.2. Checking XML language server feature flags 2.4.2.11.3. Enabling XML Language Server Protocol (LSP) tracing 2.4.2.11.4. Viewing the XML language server log 2.4.2.12. Viewing logs for YAML Expand section "2.4.2.12. Viewing logs for YAML" Collapse section "2.4.2.12. Viewing logs for YAML" 2.4.2.12.1. Verifying the state of the YAML language server 2.4.2.12.2. Checking the YAML language server feature flags 2.4.2.12.3. Enabling YAML Language Server Protocol (LSP) tracing 2.4.2.13. Viewing logs for Dotnet with Omnisharp-Theia plug-in Expand section "2.4.2.13. Viewing logs for Dotnet with Omnisharp-Theia plug-in" Collapse section "2.4.2.13. Viewing logs for Dotnet with Omnisharp-Theia plug-in" 2.4.2.13.1. Omnisharp-Theia plug-in 2.4.2.13.2. Verifying the state of the Omnisharp-Theia plug-in language server 2.4.2.13.3. Checking Omnisharp Che-Theia plug-in language server features 2.4.2.13.4. Viewing Omnisharp-Theia plug-in logs in the Output panel 2.4.2.14. Viewing logs for Dotnet with NetcoredebugOutput plug-in Expand section "2.4.2.14. Viewing logs for Dotnet with NetcoredebugOutput plug-in" Collapse section "2.4.2.14. Viewing logs for Dotnet with NetcoredebugOutput plug-in" 2.4.2.14.1. NetcoredebugOutput plug-in 2.4.2.14.2. Verifying the state of the NetcoredebugOutput plug-in 2.4.2.14.3. Viewing NetcoredebugOutput plug-in logs in the Output panel 2.4.2.15. Viewing logs for Camel Expand section "2.4.2.15. Viewing logs for Camel" Collapse section "2.4.2.15. Viewing logs for Camel" 2.4.2.15.1. Verifying the state of the Camel language server 2.4.2.15.2. Viewing Camel logs in the Output panel 2.5. Viewing the plug-in broker logs 3. Monitoring CodeReady Workspaces Expand section "3. Monitoring CodeReady Workspaces" Collapse section "3. Monitoring CodeReady Workspaces" 3.1. Enabling CodeReady Workspaces metrics collections 3.2. Collecting CodeReady Workspaces metrics with Prometheus Expand section "3.2. Collecting CodeReady Workspaces metrics with Prometheus" Collapse section "3.2. Collecting CodeReady Workspaces metrics with Prometheus" 3.2.1. Prometheus terminology 3.2.2. Configuring Prometheus 3.3. Viewing CodeReady Workspaces metrics on Grafana dashboards Expand section "3.3. Viewing CodeReady Workspaces metrics on Grafana dashboards" Collapse section "3.3. Viewing CodeReady Workspaces metrics on Grafana dashboards" 3.3.1. Configuring and deploying Grafana 3.3.2. Grafana dashboards overview Expand section "3.3.2. Grafana dashboards overview" Collapse section "3.3.2. Grafana dashboards overview" 3.3.2.1. CodeReady Workspaces server dashboard 3.3.2.2. CodeReady Workspaces server JVM dashboard 3.4. Developing Grafana dashboards 3.5. Extending CodeReady Workspaces monitoring metrics 4. Tracing CodeReady Workspaces Expand section "4. Tracing CodeReady Workspaces" Collapse section "4. Tracing CodeReady Workspaces" 4.1. Tracing API 4.2. Tracing backend 4.3. Enabling CodeReady Workspaces metrics collections 4.4. Viewing CodeReady Workspaces traces in Jaeger UI 4.5. CodeReady Workspaces tracing codebase overview and extension guide Expand section "4.5. CodeReady Workspaces tracing codebase overview and extension guide" Collapse section "4.5. CodeReady Workspaces tracing codebase overview and extension guide" 4.5.1. Tagging 5. Securing CodeReady Workspaces Expand section "5. Securing CodeReady Workspaces" Collapse section "5. Securing CodeReady Workspaces" 5.1. Authenticating users Expand section "5.1. Authenticating users" Collapse section "5.1. Authenticating users" 5.1.1. Authenticating to the CodeReady Workspaces server Expand section "5.1.1. Authenticating to the CodeReady Workspaces server" Collapse section "5.1.1. Authenticating to the CodeReady Workspaces server" 5.1.1.1. Authenticating to the CodeReady Workspaces server using OpenID Expand section "5.1.1.1. Authenticating to the CodeReady Workspaces server using OpenID" Collapse section "5.1.1.1. Authenticating to the CodeReady Workspaces server using OpenID" 5.1.1.1.1. Obtaining the token from credentials through Keycloak 5.1.1.1.2. Obtaining the token from the OpenShift token through Keycloak 5.1.1.2. Authenticating to the CodeReady Workspaces server using other authentication implementations 5.1.1.3. Authenticating to the CodeReady Workspaces server using OAuth 5.1.1.4. Using Swagger or REST clients to execute queries 5.1.2. Authenticating in a workspace Expand section "5.1.2. Authenticating in a workspace" Collapse section "5.1.2. Authenticating in a workspace" 5.1.2.1. Creating secure servers 5.1.2.2. Workspace JWT token 5.1.2.3. Machine token validation 5.2. Authorizing users Expand section "5.2. Authorizing users" Collapse section "5.2. Authorizing users" 5.2.1. workspace permissions 5.2.2. CodeReady Workspaces organization permissions 5.2.3. CodeReady Workspaces system permissions 5.2.4. manageSystem permission 5.2.5. monitorSystem permission 5.2.6. Listing CodeReady Workspaces permissions 5.2.7. Assigning CodeReady Workspaces permissions 5.2.8. Sharing CodeReady Workspaces permissions 6. Removing user data Legal Notice Settings Close Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Chapter 6. Removing user data To remove all user data, see the CodeReady Workspaces 2.0 Installation Guide. Previous Next