-
Notifications
You must be signed in to change notification settings - Fork 12
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
219 bundle documentation #298
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,89 @@ | ||||||||||||||||
--- | ||||||||||||||||
id: admin_server_bundles_and_addons | ||||||||||||||||
title: Bundles & Addons | ||||||||||||||||
sidebar_label: Bundles & Addons | ||||||||||||||||
description: Bundles & Addons Documentation. | ||||||||||||||||
toc_max_heading_level: 5 | ||||||||||||||||
--- | ||||||||||||||||
|
||||||||||||||||
## About Bundles & Addons | ||||||||||||||||
### Bundles vs Addon | ||||||||||||||||
A bundle is a set of addons. | ||||||||||||||||
addon is a set of code and settings used to extend AYON server and pipeline. | ||||||||||||||||
|
||||||||||||||||
Bundles can be marked as `production`, `staging`, `<dev-bundle-name>` variant. | ||||||||||||||||
|
||||||||||||||||
:::note Launch with different variants | ||||||||||||||||
You can use different variants with the launcher. | ||||||||||||||||
you can specify with variant to use by using the following flags with ayon launcher | ||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||
- `--use-staging` | ||||||||||||||||
- `--use-dev` | ||||||||||||||||
|
||||||||||||||||
You can overriding the default behavior and specifying the bundle on launch. | ||||||||||||||||
more info check [How to use different bundles with different projects?](https://community.ynput.io/t/how-to-use-different-bundles-with-different-projects/1096) | ||||||||||||||||
Comment on lines
+22
to
+23
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||
::: | ||||||||||||||||
|
||||||||||||||||
:::note | ||||||||||||||||
Dev variant is the same as dev bundle name `<dev-bundle-name>` | ||||||||||||||||
Dev bundle are only accessible for the **assigned admin user**. | ||||||||||||||||
Comment on lines
+26
to
+28
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||
::: | ||||||||||||||||
|
||||||||||||||||
### How Settings work | ||||||||||||||||
|
||||||||||||||||
This variant is used across the addons. | ||||||||||||||||
Each addon is saved on the server with different variant of settings. | ||||||||||||||||
The variant used in addons is exposed on the bundle. | ||||||||||||||||
The variant value on the bundle is like a main switch that set all the addons to use that variant value. | ||||||||||||||||
Comment on lines
+33
to
+36
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I couldn't make any sense of this myself. 🗡️ Which variant? How is it used? Etc. It tells me too little about settings and more about variants and bundles. Maybe the "title" of the section is what confuses me "How settings work" - but it doesn't seem to be about that at all? I feel like this community forum topic has some great wording explaining how settings actually work and behave: https://community.ynput.io/t/copying-settings-between-bundles/1867 |
||||||||||||||||
|
||||||||||||||||
:::tip Settings management | ||||||||||||||||
For more info about setting management go to [Addon Settings](admin_server_settings_management.md#addon-settings) | ||||||||||||||||
::: | ||||||||||||||||
|
||||||||||||||||
### Working with bundles | ||||||||||||||||
#### Create bundles | ||||||||||||||||
You can create a bundle by either one of these ways: | ||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||
- `+ Add Bundle` | ||||||||||||||||
- Right-Click any bundle and Select `Duplicate and Edit` shortcut `Shift+D` | ||||||||||||||||
- Select any bundle and click `Duplicate and Edit` button on the upper right. | ||||||||||||||||
|
||||||||||||||||
#### Configure bundles | ||||||||||||||||
|
||||||||||||||||
Bundles are configured on creation where you specify | ||||||||||||||||
- Bundle name | ||||||||||||||||
- Launcher version | ||||||||||||||||
- Dev bundle toggle | ||||||||||||||||
- Addon versions | ||||||||||||||||
|
||||||||||||||||
After Creation these are locked and you can then only change | ||||||||||||||||
- Dependency Packages. | ||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can also still specify for which variant this bundle is active, like production, dev, etc. |
||||||||||||||||
- Change version of some server addons (that don't affect the pipeline). e.g. Jira Addon. | ||||||||||||||||
|
||||||||||||||||
:::note | ||||||||||||||||
Dev bundle supports more configurations: | ||||||||||||||||
- Assigned dev | ||||||||||||||||
- Addon versions | ||||||||||||||||
- Addon client code directory. This special one allows developers to test the client code directory without uploading the addon. | ||||||||||||||||
However, they'll still need to upload the addons to update the settings on the server. | ||||||||||||||||
Comment on lines
+65
to
+66
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we have it - this is a perfect place to just link to developer mode documentation? |
||||||||||||||||
::: | ||||||||||||||||
|
||||||||||||||||
### Working with Addons | ||||||||||||||||
#### Install Addons | ||||||||||||||||
|
||||||||||||||||
- `Addon Market` | ||||||||||||||||
- `Upload Addons` | ||||||||||||||||
|
||||||||||||||||
:::tip | ||||||||||||||||
When updating pipeline release, new addons will be installed. | ||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||||||||||||
::: | ||||||||||||||||
|
||||||||||||||||
#### Uninstall Addons | ||||||||||||||||
- `Uninstall Versions` button. | ||||||||||||||||
|
||||||||||||||||
:::caution | ||||||||||||||||
WIth local server deployment, | ||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||
You can add or remove addons by extracting and deleting files from your addons directory on your ayon-docker server. | ||||||||||||||||
::: | ||||||||||||||||
Comment on lines
+82
to
+85
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm worried this may have unforeseen consequences and isn't something we should recommend in any way. @martastain thoughts? If we want to keep this I'd rephrase it:
|
||||||||||||||||
|
||||||||||||||||
:::info | ||||||||||||||||
Developers can upload/remove addons via ayon python api. | ||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This would be best with an example, or a link to documentation that shows that particular part of that API. |
||||||||||||||||
::: |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,29 @@ | ||||||
--- | ||||||
id: admin_server_settings_management | ||||||
title: Settings Management | ||||||
sidebar_label: Settings Management | ||||||
description: Settings Management Documentation. | ||||||
toc_max_heading_level: 5 | ||||||
--- | ||||||
|
||||||
|
||||||
## Team Settings | ||||||
|
||||||
- Add Teams | ||||||
- Add team members | ||||||
- Roles | ||||||
|
||||||
## Project Anatomy Settings | ||||||
|
||||||
- Anatomy Presets | ||||||
- Anatomy Settings | ||||||
- Roots Override | ||||||
|
||||||
## Addon Settings | ||||||
|
||||||
*Addon settings are accessed via Bundles.* | ||||||
|
||||||
- Studio Settings: Addon settings on studio level. | ||||||
- Project Settings: Addon settings on project level. They inherit studio settings and allowing overrides per project. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- Studio Site Settings: Addon local settings on studio level. They don't inherit (nor override) any other settings. | ||||||
- Project Site Settings: Addon local settings on project level. They don't inherit (nor override) any other settings. | ||||||
Comment on lines
+28
to
+29
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this state that it's per site id? Or what is "local" in this case? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.