> For the complete documentation index, see [llms.txt](https://cqube.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cqube.sunbird.org/try-cqube/architecture.md).

# cQube on Gitpod

Developers can try out cQube installation and ingestion on Gitpod.

1. Login to your github account.
2. Open sunbird cqube-devops repository and fork the repo into your personal github
3. Checkout to gitpod-branch
4. Update readme.md file as follows

<figure><img src="https://lh6.googleusercontent.com/munUgcsrqtru6ODPk_UZe1ttQ5_Y3rimzo4qSvzpwlO2VB5y5x7Hol3C3I3ZItFWtOb1_pzr3JbkJurlHStaX9r1vwBQGFdPIyMPBFOPobxhteslQnL7NNC6UQgVpEIRU4CZaTqHfTZwY9vppZvsrE8" alt=""><figcaption></figcaption></figure>

Replace \<github\_username> with your actual github username

**Note:**&#x20;

* By default JH is selected as a state code.
* If you want to change the state code, you can navigate to cqube-devops/config\_files/config.yml
* Change the state code and commit the changes.

5. Commit the changes.
6. Click on Open in Gitpod
7. If you are a new user to gitpod, complete the signup process&#x20;
8. Once the registration is done then the configuration page gets displayed. Click on continue

<figure><img src="https://lh6.googleusercontent.com/m7yBxE-tustLRBevJdX_Pi2L95UOn4eFvfxaQvsDaQBFF67Nc1xI_uuNHnSDeR-l9J2bhfxwZCMaboY6ZFMBNxZgcvOV4a4z1HghwxB1R87tYexKKsBVqMHWIrRy0HhWg6_BjIr_eMZ7IP7do9GHyCE" alt=""><figcaption></figcaption></figure>

9. Automatically it sets a VM and start the cqube deployment.
10. Once the config file is generated, type no and hit enter

<figure><img src="https://lh6.googleusercontent.com/UffbSAfbylpQVsUbbJSmcxWtMB61Vj3Fb-s7kAUc_1VOnfLgVR0XkUcAibNFwsyAt3qqVv0P-Ig6pN-7H99qhR87zTWT3RYWlOEL5qkJKkHFwotQonBolzvCOegKeOYNn_c4XWc834eo46FW6kyUuQQ" alt=""><figcaption></figcaption></figure>

<br>

11. Select the default config file by typing no

<figure><img src="https://lh3.googleusercontent.com/hUQyxNEXvjqxcw8uyIp7MMjs1iqA-0i0kXitxOJ6fVcBJ9L97dS3EDOvQ4pHRGL1DEDbuYk2SjPfsQ58sYZQ31bUkkklKUQlRDIlYAoe-Vq0RXGFXlA-Dt66dGnV6ZED4s-1zC0P_2aypLZF0lyQXj8" alt=""><figcaption></figcaption></figure>

12. Wait unit the installation is done.
13. Once installation is completed, you will be able to see the url to access the dashboard

<figure><img src="https://lh6.googleusercontent.com/uflMJ0hmljQ3SL7X9zRJABF3399VDOJnLBPg8iWqxlq-dKAzoCKLF_Ilk_ptphYYB1op8gghDGKo81Rr3h8Gyo-UrRxq2OzfNvf9S0VRkDSvx5ku9ZtNi6Q4cZ3sRzJHwDLNwMe8_CB0m1YJkLwz_kY" alt=""><figcaption></figcaption></figure>

14. Access the dashboard using the url in your browser.

<figure><img src="https://lh5.googleusercontent.com/7O5gmZ0ChR6m5qS3ZD23zhq6zppbfpWImTcBBveZtbqgDjt2OU_vUunsFnFGxs7J6Y0zwYN-Z3KMLGXfSLEkUJbckVfDMvdCyn24PAZCWqb9zVkjqOVMkmmJHhLNAyNVTb73KvvctD-5VDfYHO39XPU" alt=""><figcaption></figcaption></figure>

15. Use keycloak credentials from config.yml file to login

<figure><img src="https://lh6.googleusercontent.com/JKg0nh85iepiglGJF4De4ESK7STn5_PsmNGZQgvI7Z-VhRIXM7Bwk3vxPf_0ZS_WgkBqHHfEhMbWRivfunp-6NTznzJ94ZBcgofbdf23TmsqapdTEG4nNK5Zmv2Ae2kBh1aFVbv9pl-qlxIFXRzhC3U" alt=""><figcaption></figcaption></figure>

16. Follow the [ingestion and processing ](https://cqube.sunbird.org/use-cqube/ingesting-the-data)steps to ingest the data. Once done you will be able to see the data in the dashboard.

<figure><img src="https://lh4.googleusercontent.com/0F75GP-aOCyolzj_584Nvymu6Dy6y8KfwOHN3S81p4n4vvFD5_RIbbM-24TUbq6iWpjkMwagj7ue48fWKfb2tWHVts1QiOrKbA6cgLSMEGRI3wt_kKkDiSqElWjEbTP9YZxRkhXP8uxXWTxsQ8gQmg8" alt=""><figcaption></figcaption></figure>

Cqube deployment in gitpod video link:&#x20;

[gitpod\_recording.zip](https://drive.google.com/file/d/1lc6whjXGbxuPDpDqnyJs-n4Ev6GkXmdk/view?usp=sharing)

Ingestion and processing video link:

<https://drive.google.com/file/d/1GLYfQMPJHWMfDseLiaZg1G46Zfu2Ie--/view?usp=sharing>

<br>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cqube.sunbird.org/try-cqube/architecture.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
