diff --git a/l10n-weblate/installation-and-upgrade.cfg b/l10n-weblate/installation-and-upgrade.cfg index bbe1db2a6e5..4f429632a0e 100644 --- a/l10n-weblate/installation-and-upgrade.cfg +++ b/l10n-weblate/installation-and-upgrade.cfg @@ -35,11 +35,6 @@ [type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/uyuni/server-air-gapped-deployment-uyuni.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/uyuni/server-air-gapped-deployment-uyuni.adoc [type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/uyuni/server-deployment-uyuni.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/uyuni/server-deployment-uyuni.adoc [type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/uyuni/server-migration-uyuni.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/uyuni/server-migration-uyuni.adoc -[type: asciidoc] modules/installation-and-upgrade/pages/container-management/_container-management.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/_container-management.adoc -[type: asciidoc] modules/installation-and-upgrade/pages/container-management/_monitoring-container-storage-space.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/_monitoring-container-storage-space.adoc -[type: asciidoc] modules/installation-and-upgrade/pages/container-management/_update-container-images.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/_update-container-images.adoc -[type: asciidoc] modules/installation-and-upgrade/pages/container-management/_updating-containers.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/_updating-containers.adoc -[type: asciidoc] modules/installation-and-upgrade/pages/container-management/container-security.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/container-security.adoc [type: asciidoc] modules/installation-and-upgrade/pages/container-management/mgradm-yaml-custom-configuration.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/mgradm-yaml-custom-configuration.adoc [type: asciidoc] modules/installation-and-upgrade/pages/container-management/persistent-container-volumes.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/persistent-container-volumes.adoc [type: asciidoc] modules/installation-and-upgrade/pages/container-management/start-and-stop-containers.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-management/start-and-stop-containers.adoc diff --git a/l10n-weblate/specialized-guides.cfg b/l10n-weblate/specialized-guides.cfg index b1a4a4dfa63..3d893153c80 100644 --- a/l10n-weblate/specialized-guides.cfg +++ b/l10n-weblate/specialized-guides.cfg @@ -67,6 +67,7 @@ [type: asciidoc] modules/specialized-guides/pages/salt/salt-formula-liberate.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-formula-liberate.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-formula-monitoring.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-formula-monitoring.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-formula-pxe.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-formula-pxe.adoc +[type: asciidoc] modules/specialized-guides/pages/salt/salt-formula-saline.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-formula-saline.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-formula-saltboot.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-formula-saltboot.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-formula-tftpd.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-formula-tftpd.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-formula-virtualization-guest.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-formula-virtualization-guest.adoc @@ -79,6 +80,7 @@ [type: asciidoc] modules/specialized-guides/pages/salt/salt-gitfs.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-gitfs.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-gpg-encrypted-pillars.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-gpg-encrypted-pillars.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-large-scale-tuning.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-large-scale-tuning.adoc +[type: asciidoc] modules/specialized-guides/pages/salt/salt-monitoring.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-monitoring.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-overview.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-overview.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-rate-limiting.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-rate-limiting.adoc [type: asciidoc] modules/specialized-guides/pages/salt/salt-scaling-minions.adoc $lang:translations/$lang/modules/specialized-guides/pages/salt/salt-scaling-minions.adoc diff --git a/modules/client-configuration/pages/client-upgrades-uyuni.adoc b/modules/client-configuration/pages/client-upgrades-uyuni.adoc index 223539d8e99..46ce560cc52 100644 --- a/modules/client-configuration/pages/client-upgrades-uyuni.adoc +++ b/modules/client-configuration/pages/client-upgrades-uyuni.adoc @@ -1,5 +1,8 @@ [[client-upgrades-uyuni]] = Upgrade Uyuni Clients +ifeval::[{suma-content} == true] +:noindex: +endif::[] In this section, we use openSUSE Leap as an example. diff --git a/modules/client-configuration/pages/clients-openeuler.adoc b/modules/client-configuration/pages/clients-openeuler.adoc index d3113eea8c1..a49510c9f14 100644 --- a/modules/client-configuration/pages/clients-openeuler.adoc +++ b/modules/client-configuration/pages/clients-openeuler.adoc @@ -1,5 +1,8 @@ [[clients-openeuler]] = Registering {openeuler} Clients +ifeval::[{suma-content} == true] +:noindex: +endif::[] This section contains information about registering clients running {openeuler} operating systems. diff --git a/modules/client-configuration/pages/registration-overview-openeuler.adoc b/modules/client-configuration/pages/registration-overview-openeuler.adoc index 59d2150f36f..99455a7473e 100644 --- a/modules/client-configuration/pages/registration-overview-openeuler.adoc +++ b/modules/client-configuration/pages/registration-overview-openeuler.adoc @@ -1,5 +1,8 @@ [[openeuler-registration-overview]] = OpenEuler Client Registration +ifeval::[{suma-content} == true] +:noindex: +endif::[] You can register {openeuler} clients to your {productname} Server. The method and details varies depending on the operating system of the client. diff --git a/modules/client-configuration/pages/supported-features-openeuler.adoc b/modules/client-configuration/pages/supported-features-openeuler.adoc index eece3349d27..3b0a8a61bd3 100644 --- a/modules/client-configuration/pages/supported-features-openeuler.adoc +++ b/modules/client-configuration/pages/supported-features-openeuler.adoc @@ -1,6 +1,8 @@ [[supported-features-openeuler]] = Supported {openeuler} Features - +ifeval::[{suma-content} == true] +:noindex: +endif::[] This table lists the availability of various features on {openeuler} clients. diff --git a/modules/installation-and-upgrade/pages/container-deployment/register-proxy-suma.adoc b/modules/installation-and-upgrade/pages/container-deployment/register-proxy-suma.adoc index bb684ae9ff3..3d34bf1fac8 100644 --- a/modules/installation-and-upgrade/pages/container-deployment/register-proxy-suma.adoc +++ b/modules/installation-and-upgrade/pages/container-deployment/register-proxy-suma.adoc @@ -1,5 +1,7 @@ == Register {sle-micro} and {productname} {productnumber} Proxy - +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] // Before starting obtain your SUSE Manager Registration Code from SUSE Customer Center - https://scc.suse.com. .Procedure: Registering {sle-micro} and {productname} {productnumber} Proxy diff --git a/modules/installation-and-upgrade/pages/container-management/_container-management.adoc b/modules/installation-and-upgrade/pages/container-management/_container-management.adoc deleted file mode 100644 index 2357a2b1ce4..00000000000 --- a/modules/installation-and-upgrade/pages/container-management/_container-management.adoc +++ /dev/null @@ -1 +0,0 @@ -= Container Management \ No newline at end of file diff --git a/modules/installation-and-upgrade/pages/container-management/_monitoring-container-storage-space.adoc b/modules/installation-and-upgrade/pages/container-management/_monitoring-container-storage-space.adoc deleted file mode 100644 index f5804603e9c..00000000000 --- a/modules/installation-and-upgrade/pages/container-management/_monitoring-container-storage-space.adoc +++ /dev/null @@ -1 +0,0 @@ -= Monitoring container storage space diff --git a/modules/installation-and-upgrade/pages/container-management/_update-container-images.adoc b/modules/installation-and-upgrade/pages/container-management/_update-container-images.adoc deleted file mode 100644 index dbfb2f18b8c..00000000000 --- a/modules/installation-and-upgrade/pages/container-management/_update-container-images.adoc +++ /dev/null @@ -1 +0,0 @@ -= Update container images \ No newline at end of file diff --git a/modules/installation-and-upgrade/pages/container-management/_updating-containers.adoc b/modules/installation-and-upgrade/pages/container-management/_updating-containers.adoc deleted file mode 100644 index a60768e33b0..00000000000 --- a/modules/installation-and-upgrade/pages/container-management/_updating-containers.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Update containers - -The {productname} {productnumber} Server container can be updated using the following command: - ----- -mgradm upgrade podman ----- - -This command will bring the status of the container up to date and restart the server. diff --git a/modules/installation-and-upgrade/pages/container-management/container-security.adoc b/modules/installation-and-upgrade/pages/container-management/container-security.adoc deleted file mode 100644 index 635d1efaada..00000000000 --- a/modules/installation-and-upgrade/pages/container-management/container-security.adoc +++ /dev/null @@ -1,129 +0,0 @@ -= Hardening and Improving Container Security - -Hardening a container involves implementing security measures to reduce its **attack surface** and enhance its resilience against potential threats. -In this section we have listed techinques commonly used to harden containers. -This list is not comprehensive and container security will depend on your oranization's infrastructure. - -For more information, see link:https://documentation.suse.com/de-de/sles/15-SP5/html/SLES-all/book-security.html[Security and Hardening Guide]. - - - -== Use Minimal Base Images - -{productname} {productnumber} uses {sle-micro} {microversion} as its base. -This image has fewer pre-installed packages, thus reducing the potential attack surface. - -Reduced Size:: -Minimal base images are significantly smaller in size compared to classical operating system images. -By removing unnecessary packages and libraries, these images minimize the overall footprint, leading to faster download times and reduced storage requirements. - -Focused Functionality:: -Minimal base images are designed to provide the essential functionalities needed for running containerized applications. -Minimal base images typically **include**: -+ - -* core system utilities -* runtime environments (such as the shell) -* essential libraries -+ - -Minimal base images typically **exclude** non-essential components such as: -+ - -* documentation -* development tools -* unnecessary daemons - -Improved Security:: -By minimizing the number of installed packages and dependencies, minimal base images reduce the **attack surface** and potential vulnerabilities within the container environment. -This enhances security by limiting the avenues through which malicious actors can exploit the system. - -Flexibility:: -Minimal base images offer greater flexibility for developers to customize and optimize their containerized applications. -Since these images contain only the basic necessities, developers have more control over which additional components and dependencies to include, tailoring the container environment to meet specific application requirements. - - - -== Update Regularly - -Keep container images up to date with security patches and updates. -Regularly scan container images for vulnerabilities using tools like: - - * link:https://github.com/aquasecurity/trivy[Trivy] - * link:https://www.projectquay.io/#v3[Project Quay] - * link:https://github.com/containers/skopeo[Skopeo] - - -== Enable Image Signing - -Use digital signatures to verify the authenticity and integrity of container images. -Implement image signing and verification mechanisms to ensure that only trusted images are deployed. - -Digital Signatures:: -A **digital signature** is a cryptographic mechanism used to validate the authenticity and integrity of digital content, such as container images. -It involves **generating a unique hash or checksum** of the image content and **encrypting it with a private key** to produce a signature. -This signature can be decrypted using a corresponding public key to verify its authenticity. - -Private and Public Keys:: -Image signing relies on asymmetric encryption, which involves the use of a pair of cryptographic keys: a **private key** and a **public key**. -The private key is used to generate the signature, while the public key is used to verify the signature. -The private key is kept confidential and securely stored, while the public key can be freely distributed. - -Trust Model:: -Image signing establishes a trust model where the signer of the image is implicitly trusted to vouch for its authenticity. -**Organizations typically maintain their own private key for signing images**, and **users trust images signed by that organization's key**. -Image consumers can verify the signature using the corresponding public key to ensure that the image has not been compromised or altered by malicious actors. - -Registry Integration:: -Image signing is often integrated with container image registries, such as Docker Hub or private registries like Harbor. -Registries may offer built-in support for image signing, allowing users to sign and verify images directly within the registry platform. -Signed images are typically tagged with metadata indicating their signed status and the identity of the signer. - -Verification Process:: -Before deploying a container image, the image consumer (for example, a container runtime or orchestration platform) verifies the image signature using the signer's public key. -If the signature is valid and matches the image content, the image is considered authentic and can be safely deployed. -If the signature cannot be verified or does not match the image content, the image is rejected to prevent potential security risks. - - - -== Implement User Privileges - -Run containers with the least privilege principle. -Avoid running containers as root whenever possible. -Instead, create, and use non-root users within containers to limit the impact of potential exploits. -// content coming - - -== Use Security Contexts -Leverage security features provided by container runtimes such as Podman. Configure security contexts to enforce resource limitations, network policies, and SELinux/AppArmor profiles. -// content coming - - -== Network Segmentation -Implement network segmentation to isolate containers from each other and from the host system. Use container network plugins or overlay networks to enforce network policies and restrict container communications. -// content coming - - -== Monitor Runtime Activity -Employ container runtime monitoring tools to detect and respond to suspicious activities in real-time. -Monitor container logs, file integrity, and system calls for signs of compromise or malicious behavior. -// content coming - - -== Limit Container Capabilities -Disable unnecessary Linux capabilities within containers to reduce the potential impact of privilege escalation attacks. -Use tools like `capsh` to drop or restrict capabilities as needed. -// content coming - - -== Secure Host Environment -Ensure that the underlying host system is properly secured. -Apply operating system patches, configure firewall rules, and implement access controls to protect the host from external threats. -// content coming - - -== Implement Runtime Protection -Use runtime protection mechanisms such as seccomp or AppArmor profiles to restrict the actions that container processes can perform. -Define and enforce granular security policies to prevent unauthorized access or execution of malicious code. -// content coming - diff --git a/modules/reference/pages/help/documentation-version.adoc b/modules/reference/pages/help/documentation-version.adoc index 76d573b851e..09eb651c764 100644 --- a/modules/reference/pages/help/documentation-version.adoc +++ b/modules/reference/pages/help/documentation-version.adoc @@ -4,6 +4,10 @@ The menu:Help[Documentation {productnumber}] section opens the current version of the {productname} documentation in a new browser tab. This is the documentation installed locally on your {productname} Server. -For all versions and formats of the {susemgr} documentation, including API documentation, see https://documentation.suse.com/suma/. +ifeval::[{suma-content} == true] +For all versions and formats of the {susemgr} documentation, including API documentation, see https://documentation.suse.com/ML/. +endif::[] +ifeval::[{uyuni-content} == true] For all versions and formats of the {uyuni} documentation, see https://www.uyuni-project.org/uyuni-docs/index.html. +endif::[] \ No newline at end of file diff --git a/modules/retail/pages/retail-install-uyuni.adoc b/modules/retail/pages/retail-install-uyuni.adoc index fe16487df22..f6dc677577c 100644 --- a/modules/retail/pages/retail-install-uyuni.adoc +++ b/modules/retail/pages/retail-install-uyuni.adoc @@ -1,5 +1,8 @@ [[retail-install-uyuni]] = Install Uyuni Retail Server with openSUSE +ifeval::[{suma-content} == true] +:noindex: +endif::[] {productname} {smr} Server can be installed on openSUSE. diff --git a/modules/retail/pages/retail-uyuni-branchserver.adoc b/modules/retail/pages/retail-uyuni-branchserver.adoc index 4826a73b304..adbe0347136 100644 --- a/modules/retail/pages/retail-uyuni-branchserver.adoc +++ b/modules/retail/pages/retail-uyuni-branchserver.adoc @@ -1,5 +1,8 @@ [[retail-branchserver]] = Retail Uyuni Branch Server +ifeval::[{suma-content} == true] +:noindex: +endif::[] This section covers {productname} {smr} Branch Server installation and setup, using these procedures: diff --git a/modules/retail/pages/retail-uyuni-server-setup.adoc b/modules/retail/pages/retail-uyuni-server-setup.adoc index 134a531d3f6..c967de4fb5b 100644 --- a/modules/retail/pages/retail-uyuni-server-setup.adoc +++ b/modules/retail/pages/retail-uyuni-server-setup.adoc @@ -1,5 +1,8 @@ [[retail-server-setup]] = Retail Uyuni Server Setup +ifeval::[{suma-content} == true] +:noindex: +endif::[] This section covers {productname} {smr} Server setup, using these procedures: diff --git a/modules/specialized-guides/pages/public-cloud-guide/byos/byos-overview.adoc b/modules/specialized-guides/pages/public-cloud-guide/byos/byos-overview.adoc index c21597b3d9e..9e0abcb4e27 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/byos/byos-overview.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/byos/byos-overview.adoc @@ -1,4 +1,7 @@ = {byos} Guide +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == {byoslongform} ({byos}) diff --git a/modules/specialized-guides/pages/public-cloud-guide/byos/clients.adoc b/modules/specialized-guides/pages/public-cloud-guide/byos/clients.adoc index dd493be519b..cb28701d248 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/byos/clients.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/byos/clients.adoc @@ -1,5 +1,8 @@ [[quickstart-publiccloud-clients]] = Client Registration +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] When you have your {productname} Server and, optionally, your {productname} Proxy set up, you are ready to start registering clients. diff --git a/modules/specialized-guides/pages/public-cloud-guide/byos/setup.adoc b/modules/specialized-guides/pages/public-cloud-guide/byos/setup.adoc index 49847ab3fc3..2845d177cbc 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/byos/setup.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/byos/setup.adoc @@ -1,5 +1,8 @@ [[quickstart-publiccloud-setup]] = Initial Setup +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Introduction diff --git a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-appendix.adoc b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-appendix.adoc index 3968dcebcf2..532309de5bb 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-appendix.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-appendix.adoc @@ -1,4 +1,7 @@ = Appendix +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Countries that can transact {productname} {payg} through the cloud marketplace diff --git a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-general.adoc b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-general.adoc index 3f33d81437c..0957f914d4a 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-general.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-general.adoc @@ -1,4 +1,7 @@ = Billing - General +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] :availability: AWS & Azure :sectnums!: :lastupdate: October 2023 diff --git a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-products.adoc b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-products.adoc index fc1b1674c7c..61ac4d9cc79 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-products.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-products.adoc @@ -1,4 +1,7 @@ = Billing - Products +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] :availability: AWS & Azure :sectnums!: :lastupdate: October 2023 diff --git a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-technical.adoc b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-technical.adoc index e091a00409c..d4d2e763a9c 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-technical.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-billing-technical.adoc @@ -1,4 +1,7 @@ = Billing - Technical +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] :availability: AWS & Azure :sectnums!: :lastupdate: October 2023 diff --git a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-listings.adoc b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-listings.adoc index f2bff112d7f..80eeb554ed9 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-listings.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-listings.adoc @@ -1,4 +1,7 @@ = Public Cloud Listings +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] :availability: AWS & Azure :sectnums!: :lastupdate: October 2023 diff --git a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-miscellaneous.adoc b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-miscellaneous.adoc index 19dc73f71f5..f3e455028d2 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/faq/faq-miscellaneous.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/faq/faq-miscellaneous.adoc @@ -1,4 +1,7 @@ = Miscellaneous +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] :availability: AWS & Azure :sectnums!: :lastupdate: October 2023 diff --git a/modules/specialized-guides/pages/public-cloud-guide/overview.adoc b/modules/specialized-guides/pages/public-cloud-guide/overview.adoc index fb49028478e..c1ce6132aae 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/overview.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/overview.adoc @@ -1,5 +1,8 @@ [[public-cloud-guide]] = Public Cloud Guide +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] **Updated:** {docdate} diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg-support.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg-support.adoc index 4215432b986..c68ecf750ff 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg-support.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg-support.adoc @@ -1,5 +1,7 @@ = Public Cloud Support -:toc: +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == {byos} and {payg} Support diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-configure-the-image.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-configure-the-image.adoc index 78a288a8180..81b44696120 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-configure-the-image.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-configure-the-image.adoc @@ -1,4 +1,7 @@ = {aws} Image Preparation and Configuration +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] This section covers initial preparation and configuration of the image on {aws}. diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-connections-and-bootstrapping.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-connections-and-bootstrapping.adoc index cb23af4e54b..3f1baa4b772 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-connections-and-bootstrapping.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-connections-and-bootstrapping.adoc @@ -1,4 +1,7 @@ = Connecting {payg} Clients and Client Registration +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Managing Connections and Registering {payg} and {byos} images diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-public-cloud-images.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-public-cloud-images.adoc index c8b31e9f259..e84bfa23e6b 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-public-cloud-images.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-public-cloud-images.adoc @@ -1,4 +1,7 @@ = Obtaining the {productname} Server {payg} Public Cloud Image on {aws} +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] Follow these step-by-step instructions to locate the {productname} {productnumber} {payg} image on {aws}. You can also review the latest available images for the public cloud using Pint (Public Cloud Information Tracker). diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-requirements.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-requirements.adoc index ae501044551..57a721c0de7 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-requirements.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-requirements.adoc @@ -1,4 +1,7 @@ = {aws} System Requirements +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] When setting up a {productname} {payg} instance on {aws}, it is essential to consider system requirements for optimal performance and functionality. The default requirements outlined below have been tailored for smooth deployment and operation. diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-server-setup.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-server-setup.adoc index 2dfceb19ca3..c70221fb10c 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-server-setup.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-server-setup.adoc @@ -1,5 +1,8 @@ [[aws-server-setup]] = Server Setup +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] .Procedure: Log in and Update the System . SSH into your {AWS} instance. diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-webui-configuration.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-webui-configuration.adoc index 331c45270b0..c62b4b1e55b 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-webui-configuration.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/aws/payg-aws-webui-configuration.adoc @@ -1,4 +1,7 @@ = {productname} {payg} {webui} Configuration +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Requirements diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-configure-the-image.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-configure-the-image.adoc index dbab7151dbe..3f2634136d2 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-configure-the-image.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-configure-the-image.adoc @@ -1,5 +1,9 @@ -= Initial Preparation and Configuration of the {azure} Image -This section covers initial preparation and configuration of the image on {azure}. += Initial Preparation and Configuration of the {azure} Managed Application +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] + +This section covers initial preparation and configuration of the Managed Application on {azure}. .Procedure: Configuring your {productname} instance diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-connections-and-bootstrapping.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-connections-and-bootstrapping.adoc index e6fb2a62ef1..830ce1a8bf8 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-connections-and-bootstrapping.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-connections-and-bootstrapping.adoc @@ -1,4 +1,7 @@ = {payg} Client connections and Client Registration +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Managing Connections and Registering {payg} and {byos} Images diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-public-cloud-images.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-public-cloud-images.adoc index 9e9bc80a353..943b927868a 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-public-cloud-images.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-public-cloud-images.adoc @@ -1,4 +1,7 @@ = Obtaining the {productname} Server {payg} Public Cloud Image on {azure} +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] Follow these step-by-step instructions to locate the {productname} {productnumber} {payg} image on {azure}. You can also review the latest available images for the public cloud using Pint (Public Cloud Information Tracker). diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-requirements.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-requirements.adoc index b98f2cd459d..adc71bc528c 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-requirements.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-requirements.adoc @@ -1,4 +1,9 @@ -= {azure} System Requirements += Azure System Requirements +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] + +The {productname} {payg} offering in Azure need to communicate with the Azure Billing API, therefore it is not a simple virtual machine (VM) offering. When setting up a {productname} {payg} instance on {azure}, it s essential to consider system requirements for optimal performance and functionality. The default requirements outlined below have been tailored for smooth deployment and operation. diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-server-setup.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-server-setup.adoc index d271b751e15..57f90058024 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-server-setup.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-server-setup.adoc @@ -1,5 +1,8 @@ [[azure-server-setup]] = Initial Setup +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] .Procedure: Log in and Update the System . SSH into your {azure} instance. diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-webui-configuration.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-webui-configuration.adoc index fc7dc9c34a7..ea5d5f72df6 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-webui-configuration.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/azure/payg-azure-webui-configuration.adoc @@ -1,4 +1,7 @@ = {productname} {payg} {webui} Setup +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Requirements diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/payg-limitations.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/payg-limitations.adoc index d69e46d4dd6..2a461a15334 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/payg-limitations.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/payg-limitations.adoc @@ -1,4 +1,7 @@ = {payg} Limitations +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Onboarded {byos} Instances without {scc} Credentials diff --git a/modules/specialized-guides/pages/public-cloud-guide/payg/payg-overview.adoc b/modules/specialized-guides/pages/public-cloud-guide/payg/payg-overview.adoc index 54d743262b2..a59f89d1b04 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/payg/payg-overview.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/payg/payg-overview.adoc @@ -1,4 +1,7 @@ = {payg} Overview +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] :description: {productname} {payg} or {payglongform} is a flexible and cost-effective solution that allows users to manage and monitor their systems. {payg} does not require a long-term subscription. Users can leverage the images of {productname} on a {payglongform} basis, paying only for the time of use, and the number of managed and monitored systems. diff --git a/modules/specialized-guides/pages/public-cloud-guide/public-cloud-faq.adoc b/modules/specialized-guides/pages/public-cloud-guide/public-cloud-faq.adoc index 6c364d14b69..9a508caad6d 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/public-cloud-faq.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/public-cloud-faq.adoc @@ -1,4 +1,7 @@ = {productname} {payg} on the Cloud: FAQ +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] :availability: AWS & Azure :sectnums!: :lastupdate: October 2023 diff --git a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-configure-payg-behind-proxy.adoc b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-configure-payg-behind-proxy.adoc index f7db49c1084..0fe4318079c 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-configure-payg-behind-proxy.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-configure-payg-behind-proxy.adoc @@ -1,5 +1,8 @@ [[tshoot-public-cloud-configure-payg-behind-proxy]] = Configure {payglongform} Behind Proxy +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] To identify if a machine is {payg} or not, {productname} needs to use [literal]``sudo`` to run [literal]``instance-flavor-check``tool. diff --git a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-intro.adoc b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-intro.adoc index 00256c97fad..0947f877a38 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-intro.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-intro.adoc @@ -1,5 +1,9 @@ [[troubleshooting-public-cloud]] = Troubleshooting Public Cloud +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] + :availability: AWS & Azure :sectnums!: :lastupdate: March 2024 diff --git a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-payg-checks.adoc b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-payg-checks.adoc index 003973289cf..672eaf23a79 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-payg-checks.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-payg-checks.adoc @@ -1,5 +1,8 @@ [[tshoot-public-cloud-payg-checks]] = {payg} Checks +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] //// diff --git a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-setup-separate-disk-byos.adoc b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-setup-separate-disk-byos.adoc index 63c59e4c043..826a07a0b82 100644 --- a/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-setup-separate-disk-byos.adoc +++ b/modules/specialized-guides/pages/public-cloud-guide/troubleshooting/tshoot-public-cloud-setup-separate-disk-byos.adoc @@ -1,6 +1,8 @@ [[tshoot-public-cloud-setup-separate-disk-byos]] = Set up {productname} with Separate Disk for {byos} - +ifeval::[{uyuni-content} == true] +:noindex: +endif::[] == Issue diff --git a/modules/specialized-guides/pages/salt/salt-formula-saline.adoc b/modules/specialized-guides/pages/salt/salt-formula-saline.adoc new file mode 100644 index 00000000000..245d2140508 --- /dev/null +++ b/modules/specialized-guides/pages/salt/salt-formula-saline.adoc @@ -0,0 +1,37 @@ +[[saline-formula]] + += Saline Formula + +Saline in {productname} monitoring is configured using formulas with forms. +The package is installed by default, and contains these formulas: + +* Saline Prometheus +* Saline Grafana + +These formulas are extending the configuration of Grafana and Prometheus created with xref:salt/salt-formula-monitoring.adoc[Monitoring Formulas]. + + +== Saline Prometheus + +.Procedure: Configuring the Saline Prometheus Formula +. Navigate to the menu:Formulas[Saline Prometheus] tab, and set these parameters in the [guimenu]``Saline Prometheus`` section: +* Check the [guimenu]``Enable Saline scrape configuration`` box to enable Saline Prometheus monitoring. +* In the [guimenu]``Saline port number`` field, type the port number, if it was changed while xref:salt/salt-monitoring.adoc#saline-deployment[Saline deployment] or leave default [option]``8216``, if it wasn't changed during deployment. +* Check the [guimenu]``Saline secure connection (HTTPS)`` to use secure connection to Saline (used by default). +. Click btn:[Save Formula] to save your configuration. + +== Saline Grafana + +.Procedure: Configuring the Saline Grafana Formula +. Navigate to the menu:Formulas[Saline Grafana] tab, and set these parameters in the [guimenu]``Saline Grafana`` section: +. In the [guimenu]``Dashboards`` section, check the dashboards you want to use: +* [guimenu]``{productname} server dashboard with Saline`` +* [guimenu]``{productname} Saline States Job dashboard`` +. Click btn:[Save Formula] to save your configuration. + +== Activate Forms + +When you have completed and saved all the forms, apply the highstate. + +* For more information about configuring Prometheus and Grafana with formulas, see xref:salt/salt-formula-monitoring.adoc[Monitoring Formulas]. +* For more information about using monitoring, see xref:administration:monitoring.adoc[Monitoring with Prometheus and Grafana]. diff --git a/modules/specialized-guides/pages/salt/salt-monitoring.adoc b/modules/specialized-guides/pages/salt/salt-monitoring.adoc new file mode 100644 index 00000000000..4eb827552c5 --- /dev/null +++ b/modules/specialized-guides/pages/salt/salt-monitoring.adoc @@ -0,0 +1,103 @@ +[[salt-monitoring]] += Monitoring {salt} Events + +In some cases the {salt} event bus could publish significant amount of events with a high rate, what could make it hard to analize. +Getting the statistics based on the events published in the {salt} event bus can help to identify possible weak points and perform {salt} internals profiling. + +[[saline]] +== Saline + +Saline is a powerful tool designed to function as a Prometheus exporter, enabling the collection of metrics based on events from the {salt} event bus. +These metrics are derived from event data available on the {salt} master, similar to what is accessible through the command: + +---- +mgrctl exec -ti -- salt-run state.event +---- + +Saline is distributed as a separate container image, [literal]``server-saline``, for use with {productname} Server. +All related commands and operations should be executed on the {productname} Server container host system. + +In addition to its role as a Prometheus exporter, Saline also provides the [literal]``saline-formula``, which simplifies configuration of Prometheus and Grafana dashboards, enhancing monitoring and visualization capabilities. + +[[saline-deployment]] +== Saline deployment + +To deploy Saline on the {productname} Server use [command]``mgradm upgrade podman`` with [option]``--saline-replicas 1``. +Saline can be deployed during the installation of the {productname} Server using [command]``mgradm install podman`` with [option]``--saline-replicas 1``. +The only possible values for [option]``--saline-replicas`` are ``1`` or ``0``. +The default port [option]``8216`` can be changed with specifying [option]``--saline-port NNNN`` (where [literal]``NNNN`` is a desired port number) on calling [command]``mgradm upgrade podman``. +After finishing the deployment [literal]``{productname}-server-saline@0.service`` should be configured on the {productname} Server host system. + +== {salt} master configuration recommendations + +It is recommended to add [option]``master_stats: True`` and adjust the value of [option]``master_stats_event_iter: 60`` if needed. +Then restart [command]``salt-master`` to get the detailed statistics of internal {salt} calls. +This can be help with tuning large scale deployment installations. + +== Saline formula + +To configure Prometheus and Grafana dashboards, see xref:specialized-guides:salt/salt-formula-saline.adoc[Saline Formula]. + +== Removing Saline + +To remove Saline from the {productname} Server use [command]``mgradm upgrade podman`` with [option]``--saline-replicas 0``. + +== Examples of resulting Grafana dashboards + +=== {productname} Server (with Saline) dashboard + +The dashboard represents {salt} events with the different views presented on the panels. + +[[salt-events-panel]] +=== Salt Events + +The panel represents all the {salt} events grouped by categories. [literal]``Salt events`` represents the total number of all categories of the events. + +image::saline-salt-events.png[Salt Events] + +=== Minions Activity + +The panel provides the minions activity status for the specified interval of times. It shows the amount of minions which were active in last minute, 5 minutes, 15 minutes, 1 hour or considered offline on this moment of time or even ever seen (could be targeted or either responded or not) or active. + +image::saline-salt-minions-activity.png[Minions Activity] + +=== Salt Events by Tags and Functions + +The panel provides the detailed representation of xref:specialized-guides:salt/salt-monitoring.adoc#salt-events-panel[Salt Events] with the event spread by direction +The events which are send to the minions are presented on the positive side of the axis, while the events received from the minions are presented on the negative side. + +image::saline-salt-events-by-tags-and-fun.png[Salt Events by Tags and Functions] + +=== Salt States + +The panel represents states apply process events grouped by the status: succeeded, failed, causing errors or applied in the test mode. + +image::saline-salt-states.png[Salt States] + +=== Salt Master Stats (runs) + +The panel represents the number of internal calls grouped by function, which are exposed with {salt} stats. + +image::saline-salt-master-stats-runs.png[Salt Master Stats (runs)] + +=== Salt Master Stats (avg. duration) + +The panel represents the average duration of internal calls grouped by function, which are exposed with {salt} stats. + +image::saline-salt-master-stats-durations.png[Salt Master Stats (avg. duration)] + +== Saline State Jobs dashboard + +The dashboard represents {salt} state apply process, it can be used for detailed monitoring of the internals of state apply process initiated for a number of targets. + +=== Salt State Jobs (instant) + +The panel represents an instant view of the state functions calls represented in the table view. + +image::saline-salt-state-jobs.png[Salt State Jobs (instant)] + +=== Salt States Profiling + +The panel provides the table of state functions calls with the detailed profiling data that can be used for state optimization. + +image::saline-salt-states-profiling.png[Salt States Profiling]