mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2026-10-21 21:12:01 +00:00
feat(oci): a notification for Modify, and the documentation under the same name
This commit is contained in:
MacRimi
@@ -55,7 +55,7 @@
|
||||
"table": {
|
||||
"headers": ["Read from the image", "Not in the image", "Consequence"],
|
||||
"rows": [
|
||||
["<code>Entrypoint</code>, <code>Cmd</code>, <code>User</code>, <code>WorkingDir</code> and embedded environment", "Variables that only appear in the documentation", "They are added during the installation or a recreation"],
|
||||
["<code>Entrypoint</code>, <code>Cmd</code>, <code>User</code>, <code>WorkingDir</code> and embedded environment", "Variables that only appear in the documentation", "They are added during the installation or with Modify"],
|
||||
["Volumes declared by the image", "Host directories that only a Compose file names", "Additional paths are added before installing"],
|
||||
["<code>EXPOSE</code> ports", "The URL, protocol or functional healthcheck", "The port and the way the service is checked are confirmed"],
|
||||
["Architectures and digest in the registry", "Devices, privileges or external dependencies", "None of them is enabled without a definition that asks for it"]
|
||||
|
||||
@@ -40,7 +40,7 @@
|
||||
"items": [
|
||||
"<strong>Search applications</strong> — search by name across the catalog.",
|
||||
"<strong>All applications</strong> — the complete catalog, with the number of applications.",
|
||||
"<strong>Manage installed OCI applications</strong> — update, recreate, remove or recover what was installed.",
|
||||
"<strong>Manage installed OCI applications</strong> — update, modify, remove or recover what was installed.",
|
||||
"<strong>Install an image that is not in the catalog</strong> — translate a Compose file, a <code>docker run</code> command or an image reference.",
|
||||
"The catalog categories, each with its number of applications."
|
||||
]
|
||||
@@ -108,7 +108,7 @@
|
||||
{ "label": "Data, paths and networking", "href": "/docs/oci-manager/storage-network", "tail": "container disks, host directories, Rclone mounts and addresses." },
|
||||
{ "label": "Devices and acceleration", "href": "/docs/oci-manager/hardware", "tail": "GPU, NVIDIA, Coral, USB and other devices." },
|
||||
{ "label": "Multi-container applications", "href": "/docs/oci-manager/stacks", "tail": "application, database and cache as coordinated LXCs." },
|
||||
{ "label": "Install, update and recreate", "href": "/docs/oci-manager/lifecycle", "tail": "the instance contract and its operations." },
|
||||
{ "label": "Install, update and modify", "href": "/docs/oci-manager/lifecycle", "tail": "the instance contract and its operations." },
|
||||
{ "label": "In ProxMenux Monitor", "href": "/docs/oci-manager/monitor", "tail": "versions, updates, console output and terminal." }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Install, update and recreate | ProxMenux",
|
||||
"description": "The instance contract of an OCI container and the operations that use it: update, recreate, remove, recovery of an interrupted operation and recovery after a restore on this or another host."
|
||||
"title": "Install, update and modify | ProxMenux",
|
||||
"description": "The instance contract of an OCI container and the operations that use it: update, modify, remove, recovery of an interrupted operation and recovery after a restore on this or another host."
|
||||
},
|
||||
"header": {
|
||||
"title": "Install, update and recreate",
|
||||
"title": "Install, update and modify",
|
||||
"description": "Each instance keeps a reproducible contract, so its rootfs can be replaced without losing configuration or persistent data.",
|
||||
"section": "OCI manager Apps"
|
||||
},
|
||||
@@ -22,14 +22,14 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"p": "A copy of the contract travels inside the container, in <code>/.proxmenux/oci-record.json</code>, readable only by root of the container, so a backup of the container always carries the contract it had at that moment. A second copy is kept in <code>/etc/pve/priv/proxmenux/oci</code>, which every node of a cluster shares and only root of the host reads. Both are written after every installation, update and recreation."
|
||||
"p": "A copy of the contract travels inside the container, in <code>/.proxmenux/oci-record.json</code>, readable only by root of the container, so a backup of the container always carries the contract it had at that moment. A second copy is kept in <code>/etc/pve/priv/proxmenux/oci</code>, which every node of a cluster shares and only root of the host reads. Both are written after every installation, update and change."
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "manage",
|
||||
"title": "Manage installed OCI applications",
|
||||
"intro": "This option of the main screen lists the registered instances with their application and image. Each one is checked against its contract before any action; a CT that no longer matches its record is neither modified nor deleted. The same update and recreation are offered in the Updates tab of <monitorLink>ProxMenux Monitor</monitorLink>.",
|
||||
"intro": "This option of the main screen lists the registered instances with their application and image. Each one is checked against its contract before any action; a CT that no longer matches its record is neither modified nor deleted. The same update and the same editor are offered in the Updates tab of <monitorLink>ProxMenux Monitor</monitorLink>.",
|
||||
"blocks": [
|
||||
{
|
||||
"table": {
|
||||
@@ -45,7 +45,7 @@
|
||||
"Contract, container disks, host directories, network and devices"
|
||||
],
|
||||
[
|
||||
"Recreate: edit resources, network, paths and GPU",
|
||||
"Modify: edit resources, network, paths and GPU",
|
||||
"The editor opens with the current contract; the CT is rebuilt with the changes",
|
||||
"The data of container disks and host directories"
|
||||
],
|
||||
@@ -58,12 +58,12 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"p": "For a multi-container application the menu offers <strong>Update every container of the application</strong>, <strong>Recreate</strong> and the removal. Recreate adds or removes the extra paths and devices of the application container without rebuilding anything and, in Immich, changes what runs recognition."
|
||||
"p": "For a multi-container application the menu offers <strong>Update every container of the application</strong>, <strong>Modify extra paths and devices</strong>, <strong>Recreate every container with its saved configuration</strong> and the removal. Modify adds or removes the extra paths and devices of the application container without rebuilding anything and, in Immich, changes what runs recognition. Recreate rebuilds every container from the image it was installed with, without looking for a newer one."
|
||||
},
|
||||
{
|
||||
"figure": {
|
||||
"src": "/oci-manager/manage-menu.png",
|
||||
"alt": "List of installed OCI applications and the update, recreate and remove options",
|
||||
"alt": "List of installed OCI applications and the update, modify and remove options",
|
||||
"caption": "Manage installed OCI applications."
|
||||
}
|
||||
}
|
||||
@@ -126,7 +126,7 @@
|
||||
{
|
||||
"id": "recovery",
|
||||
"title": "Recovering an interrupted operation",
|
||||
"intro": "Update and recreation use a persistent transaction. If the process, the terminal or the node is interrupted after the CT stops, the operation is not taken as finished.",
|
||||
"intro": "An update and a change use a persistent transaction. If the process, the terminal or the node is interrupted after the CT stops, the operation is not taken as finished.",
|
||||
"blocks": [
|
||||
{
|
||||
"steps": {
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
],
|
||||
[
|
||||
"Updates",
|
||||
"The image is updated or the container recreated, with the same flow as the OCI menu"
|
||||
"The image is updated or the application modified, with the same flow as the OCI menu"
|
||||
],
|
||||
[
|
||||
"Mounts",
|
||||
@@ -107,8 +107,8 @@
|
||||
"The update of <lifecycleLink>Manage installed OCI applications</lifecycleLink> for this container, in the Monitor terminal. It can run whether or not there is a new image; with none, nothing is changed. In a multi-container application it updates every member."
|
||||
],
|
||||
[
|
||||
"Recreate",
|
||||
"The recreation editor (resources, network, paths and GPU). In a multi-container application it adds or removes the extra paths and devices of the application container and, in Immich, changes what runs recognition."
|
||||
"Modify",
|
||||
"The editor of the application (resources, network, paths and GPU). In a multi-container application it adds or removes the extra paths and devices of the application container and, in Immich, changes what runs recognition."
|
||||
],
|
||||
[
|
||||
"Recover",
|
||||
@@ -116,7 +116,7 @@
|
||||
],
|
||||
[
|
||||
"Recover (restored container)",
|
||||
"Shown for a container restored from a backup that has no contract on this host, under <strong>Restored OCI application</strong>. Opens the <lifecycleLink>recovery</lifecycleLink> in the Monitor terminal; Update and Recreate appear once it is registered."
|
||||
"Shown for a container restored from a backup that has no contract on this host, under <strong>Restored OCI application</strong>. Opens the <lifecycleLink>recovery</lifecycleLink> in the Monitor terminal; Update and Modify appear once it is registered."
|
||||
]
|
||||
]
|
||||
}
|
||||
|
||||
@@ -295,7 +295,7 @@
|
||||
{
|
||||
"id": "manage",
|
||||
"title": "Managing an installed stack",
|
||||
"intro": "In <strong>Manage installed OCI applications</strong>, any member leads to the whole stack. The menu of a stack offers <strong>Update every container of the application</strong>, <strong>Recreate: add or remove extra paths and devices</strong> and <strong>Remove: delete the application and its containers</strong>.",
|
||||
"intro": "In <strong>Manage installed OCI applications</strong>, any member leads to the whole stack. The menu of a stack offers <strong>Update every container of the application</strong>, <strong>Modify extra paths and devices</strong>, <strong>Recreate every container with its saved configuration</strong> and <strong>Remove: delete the application and its containers</strong>. Recreate rebuilds every container from the image it was installed with, by its saved digest and without looking for a newer one, with the same steps as an update; it is offered for the stacks that can be updated.",
|
||||
"blocks": [
|
||||
{
|
||||
"steps": {
|
||||
@@ -330,7 +330,7 @@
|
||||
{
|
||||
"table": {
|
||||
"headers": [
|
||||
"Recreate",
|
||||
"Modify",
|
||||
"What changes",
|
||||
"What is kept"
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user