You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quix-cloud/managed-services/plugin.md
+50-5Lines changed: 50 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
The plugin system enables services to expose an embedded UI inside Deployment Details (rendered as an iframe), and optionally add a shortcut in the environment’s left sidebar.
4
4
5
-
Managed services could (or could not) populate these plugin properties automatically via the Managed Framework. You can always override them explicitly via YAML if needed.
5
+
Managed services may populate these plugin properties automatically via the Managed Framework, and you can always override them explicitly in YAML.
6
6
7
-
Non‑managed services can also define these properties in YAML, making any deployment of your pipeline behave like a plugin without being a managed service.
7
+
Non‑managed services can also define these properties in YAML, making any deployment behave like a plugin without being a managed service.
8
8
9
9
## What it does
10
10
@@ -18,7 +18,7 @@ Non‑managed services can also define these properties in YAML, making any depl
18
18
19
19
- Provide basic authentication integration with Quix Cloud so publicly exposed services don’t require a separate login
20
20
21
-
## YAML
21
+
## YAML configuration
22
22
23
23
In your deployment YAML, you can enable the embedded UI and, optionally, a sidebar item:
24
24
@@ -39,15 +39,60 @@ Notes
39
39
40
40
## Embedded view URL
41
41
42
-
When the plugin feature is enabled, the deployment exposes a public URL dedicated to the embedded UI. The Portal uses this URL to load the embedded view inside the iframe when `embeddedView` is enabled.
42
+
When the plugin feature is enabled, the deployment exposes a public URL dedicated to the embedded UI. The Portal uses this URL to load the embedded view inside the iframe when `embeddedView` is enabled. This URL is not set in YAML; it’s exposed by the API.
43
43
44
44
Population rules:
45
45
46
46
- Managed service → Derived from Managed Services conventions.
47
-
- Non‑managed service → The `publicAccess` configuration needs to be enabled.
47
+
- Non‑managed service → Requires `publicAccess` to be enabled; resolves from the deployment’s public URL.
48
48
49
49
## Authentication and authorization
50
50
51
51
The embedded view inherits authentication and authorization from the Quix platform: no separate login is required, and the same user/environment permissions apply.
52
52
When an embedded view loads, the Plugin system injects the Quix user token into the iframe. The UI uses this token to call the backend securely.
53
53
54
+
### How the token is injected in the embedded view
55
+
56
+
On initial load of the embedded view (and on reload), the Portal provides the user token to the iframe so the UI can authenticate calls to the backend.
57
+
58
+
### How to handle the token in the backend
59
+
60
+
Install the Quix Portal helper package from the public feed:
0 commit comments