Updated documentation for adding support for addon target configuration #1974
Conversation
jgoakley
force-pushed
the
add-support-for-addon-target-path
branch
from
611b1e9 to
521513a
Compare
frenck
force-pushed
the
add-support-for-addon-target-path
branch
from
89fee91 to
ff41dbf
Compare
WalkthroughWalkthroughThe Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Configuration.md
participant Ports_Section as Ports Section
participant AppArmor_Section as AppArmor Section
User->>Configuration.md: Modify configurations
Configuration.md->>Ports_Section: Update map property
Ports_Section->>User: Types (share, ssl, homeassistant_config), Attributes (read_only)
Configuration.md->>AppArmor_Section: Expand map property
AppArmor_Section->>User: Directory types (data), Configurable paths
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional context usedLanguageTool
Markdownlint
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| - type: ssl | ||
| - type: homeassistant_config | ||
| read_only: False | ||
| path: /custom/config/path |
There was a problem hiding this comment.
Ensure the path property is well-explained.
The path property is described, but consider adding a brief note about its purpose and constraints for clarity.
+ # The `path` property allows you to specify a custom path inside the container. Ensure it is unique and not empty.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| path: /custom/config/path | |
| # The `path` property allows you to specify a custom path inside the container. Ensure it is unique and not empty. | |
| path: /custom/config/path |
| - type: share | ||
| read_only: False | ||
| - type: ssl | ||
| - type: homeassistant_config | ||
| read_only: False | ||
| path: /custom/config/path |
There was a problem hiding this comment.
Clarify the read_only property usage.
The documentation is clear but consider adding a brief explanation of the read_only property for users who might be unfamiliar with it.
+ # The `read_only` property specifies whether the directory is read-only. Set to `False` to allow write access.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - type: share | |
| read_only: False | |
| - type: ssl | |
| - type: homeassistant_config | |
| read_only: False | |
| path: /custom/config/path | |
| - type: share | |
| read_only: False # The `read_only` property specifies whether the directory is read-only. Set to `False` to allow write access. | |
| - type: ssl | |
| - type: homeassistant_config | |
| read_only: False | |
| path: /custom/config/path |
| @@ -154,7 +158,7 @@ Avoid using `config.yaml` as filename in your add-on for anything other than the | |||
| | `privileged` | list | | Privilege for access to hardware/system. Available access: `BPF`, `DAC_READ_SEARCH`, `IPC_LOCK`, `NET_ADMIN`, `NET_RAW`, `PERFMON`, `SYS_ADMIN`, `SYS_MODULE`, `SYS_NICE`, `SYS_PTRACE`, `SYS_RAWIO`, `SYS_RESOURCE` or `SYS_TIME`. | |||
| | `full_access` | bool | `false` | Give full access to hardware like the privileged mode in Docker. Works only for not protected add-ons. Consider using other add-on options instead of this, like `devices`. If you enable this option, don't add `devices`, `uart`, `usb` or `gpio` as this is not needed. | |||
| | `apparmor` | bool/string | `false` | Enable or disable AppArmor support. If it is enabled, you can also use custom profiles with the name of the profile. | |||
| | `map` | list | | List of Home Assistant directories to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, and `all_addon_configs`. Defaults to `ro`, which you can change by adding `:rw` to the end of the name. | |||
| | `map` | list | | List of Home Assistant directory types to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, `all_addon_configs`, and `data`. Defaults to read-only, which you can change by adding the property `read_only: false`. By default, all paths map to `/<type-name>` inside the addon container, but an optional `path` property can also be supplied to configure the path (Example: `path: /custom/config/path`). If used, the path must not be empty, unique from any other path defined for the addon, and not the root path. Note that the `data` directory is always mapped and writable, but the `path` property can be set using the same conventions. | |||
There was a problem hiding this comment.
Clarify the data directory behavior.
The documentation mentions that the data directory is always mapped and writable. Consider adding a brief explanation about the typical usage scenarios for the data directory.
+ # The `data` directory is always mapped and writable. It is typically used for storing persistent data required by the add-on.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `map` | list | | List of Home Assistant directory types to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, `all_addon_configs`, and `data`. Defaults to read-only, which you can change by adding the property `read_only: false`. By default, all paths map to `/<type-name>` inside the addon container, but an optional `path` property can also be supplied to configure the path (Example: `path: /custom/config/path`). If used, the path must not be empty, unique from any other path defined for the addon, and not the root path. Note that the `data` directory is always mapped and writable, but the `path` property can be set using the same conventions. | |
| | `map` | list | | List of Home Assistant directory types to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, `all_addon_configs`, and `data`. Defaults to read-only, which you can change by adding the property `read_only: false`. By default, all paths map to `/<type-name>` inside the addon container, but an optional `path` property can also be supplied to configure the path (Example: `path: /custom/config/path`). If used, the path must not be empty, unique from any other path defined for the addon, and not the root path. Note that the `data` directory is always mapped and writable, but the `path` property can be set using the same conventions. | |
| # The `data` directory is always mapped and writable. It is typically used for storing persistent data required by the add-on. |
Tools
LanguageTool
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...t into your container. Possible values:homeassistant_config,addon_config,ssl, `addons...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...ossible values:homeassistant_config,addon_config,ssl,addons,backup, `sh...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...homeassistant_config,addon_config,ssl,addons,backup,share,media,...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...sistant_config,addon_config,ssl,addons,backup,share,media,all_addo...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...,addons,backup,share,media,all_addon_configs, anddata. Defaults to read-...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ... paths map to/<type-name>inside the addon container, but an optionalpathprope...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...que from any other path defined for the addon, and not the root path. Note that the `...(MORFOLOGIK_RULE_EN_US)
Markdownlint
161-161: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
Ensure the path property is well-explained.
The path property is described, but consider adding a brief note about its purpose and constraints for clarity.
+ # The `path` property allows you to specify a custom path inside the container. Ensure it is unique and not empty.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `map` | list | | List of Home Assistant directory types to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, `all_addon_configs`, and `data`. Defaults to read-only, which you can change by adding the property `read_only: false`. By default, all paths map to `/<type-name>` inside the addon container, but an optional `path` property can also be supplied to configure the path (Example: `path: /custom/config/path`). If used, the path must not be empty, unique from any other path defined for the addon, and not the root path. Note that the `data` directory is always mapped and writable, but the `path` property can be set using the same conventions. | |
| | `map` | list | | List of Home Assistant directory types to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, `all_addon_configs`, and `data`. Defaults to read-only, which you can change by adding the property `read_only: false`. By default, all paths map to `/<type-name>` inside the addon container, but an optional `path` property can also be supplied to configure the path (Example: `path: /custom/config/path`). If used, the path must not be empty, unique from any other path defined for the addon, and not the root path. Note that the `data` directory is always mapped and writable, but the `path` property can be set using the same conventions. | |
| # The `path` property allows you to specify a custom path inside the container. Ensure it is unique and not empty. |
Tools
LanguageTool
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...t into your container. Possible values:homeassistant_config,addon_config,ssl, `addons...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...ossible values:homeassistant_config,addon_config,ssl,addons,backup, `sh...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...homeassistant_config,addon_config,ssl,addons,backup,share,media,...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...sistant_config,addon_config,ssl,addons,backup,share,media,all_addo...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...,addons,backup,share,media,all_addon_configs, anddata. Defaults to read-...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ... paths map to/<type-name>inside the addon container, but an optionalpathprope...(MORFOLOGIK_RULE_EN_US)
[misspelling] ~161-~161: Possible spelling mistake found.
Context: ...que from any other path defined for the addon, and not the root path. Note that the `...(MORFOLOGIK_RULE_EN_US)
Markdownlint
161-161: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
Proposed change
Documentation change for pull request: (home-assistant/supervisor#4694)
Type of change
Additional information
Summary by CodeRabbit
Documentation
mapproperty for theportsandapparmorsections.datawith customizable paths for better flexibility in container configurations.New Features
share,ssl,homeassistant_config) with properties likeread_onlyand customizable paths in themapproperty.