Skip to content

chore: update shared app related doc #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

cal-weng
Copy link
Collaborator

This PR replaced the original cluster-scoped concept with "shared application". Following docs are impacted:

  • Applications under Concepts
  • Install, uninstall and update under Tasks
  • Manage GPU usage under Tasks
  • Roles and user Permissions
  • Open WebUI under Use cases.

Copy link

vercel bot commented Apr 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 0:44am
docs-joinolares ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 0:44am
docs-main ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 0:44am
docs-terminus ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 0:44am

* **Centralized management**: Only administrators can install the core service of a shared application. Administrators are responsible for installing, configuring, and hosting the app's service, resources, and runtime environment within the cluster.
* **Easy identification**: In Olares Market, shared applications are typically marked with a "Shared" label for easy identification.
* **Flexible access**: The method for accessing a shared application depends on the app's form:
* **Headless backend service**: For shared applications that do not have a direct user interface (e.g., Ollama), users typically need to install an **authorized application** to serve as the service access point. For example, users within the cluster can access the Ollama service via Open WebUI or LobeChat.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps use another example. Now there’s a visible entrance for Ollama.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or, don't mention it at all?


Authorized applications are applications that have been granted access to specific shared applications within Olares. They typically provide a user-friendly interface, allowing users to easily access the APIs or services exposed by the shared applications.

For example, Open WebUI, LobeChat, and n8n are authorized applications for Ollama. Dify Shared is the authorized application of itself.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Originally, an authorized application refers to the cluster-side interface for a cluster application (e.g., ComfyUI for Cluster & ComfyUI). The reason we introduced the “Shared” version was to simplify the explanation and avoid the need to clarify why two applications must be installed to run a single service.

In this sense, Open WebUI, LobeChat, and n8n are not authorized applications for Ollama. This is because Ollama can operate independently, and users can access online models without needing to install Ollama. Perhaps you meant “reference applications” here? As they might serve as separate applications to access the service?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So perhaps we don't need to introduce what an authorized application is? Or we keep all of these concepts, because users can see “ComfyUI Shared”, “ComfyUI” and “ComfyUI Shared” at the same time.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TShentu Comments?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is referring to "reference applications." Both the Shared app and the Reference app should be explained here. Typically, each application runs in its own sandbox (namespace) and cannot access other applications’ sandboxes. However, in this case, the Reference app is pre-authorized by the Shared app, allowing it to access the Shared app’s sandbox data.

The key message is that reference applications represent a special exception in which an app chooses to share its sandbox data with another app, allowing the receiving app to access that otherwise private information.

Copy link
Collaborator Author

@cal-weng cal-weng Apr 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think being an authorized application of a shared app rules out the option of the app to access other online resources. It just means the app is authorized to access the service/resource of the shared app. Also as I understand it, we replaced reference app with authorized app... so these two (reference app and authorized app) are the same in this context...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants