Support
Using support tools for MicroShift
Abstract
Chapter 1. The etcd service
The etcd service is delivered as part of the MicroShift RPM. The etcd service is run as a separate process and the lifecycle is managed automatically by MicroShift.
1.1. Observe and debug the MicroShift etcd server
You can gather journalctl logs to observe and debug the etcd server logs.
Prerequisites
- The MicroShift service is running.
Procedure
To get the logs for etcd, run the following command:
$ sudo journalctl -u microshift-etcd.scope
NoteMicroShift logs can be accessed separately from etcd logs using the
journalctl -u microshiftcommand.
1.2. Configuring the memoryLimitMB value to set parameters for the etcd server
By default, etcd will use as much memory as necessary to handle the load on the system. In some memory constrained systems, it might be necessary to limit the amount of memory etcd is allowed to use at a given time.
Procedure
Edit the
/etc/microshift/config.yamlfile to set thememoryLimitMBvalue.etcd: memoryLimitMB: 128
NoteThe minimum permissible value for
memoryLimitMBon MicroShift is 128 MB. Values close to the minimum value are more likely to impact etcd performance. The lower the limit, the longer etcd takes to respond to queries. If the limit is too low or the etcd usage is high, queries time out.
Verification
After modifying the
memoryLimitMBvalue in/etc/microshift/config.yaml, restart MicroShift by running the following command:$ sudo systemctl restart microshift
Verify the new
memoryLimitMBvalue is in use by running the following command:$ systemctl show --property=MemoryHigh microshift-etcd.scope
Chapter 2. Using sos reports
You can use the sos tool to collect troubleshooting information about a host. The sos report command generates a detailed report that shows all of the enabled plugins and data from the different components and applications in a system.
2.1. About sos reports
The sos tool is composed of different plugins that help you gather information from different applications. A MicroShift-specific plugin has been added from sos version 4.5.1, and it can gather the following data:
- MicroShift configuration and version
- YAML output for cluster-wide and system namespaced resources
- OVN-Kubernetes information
2.2. Gathering data from an sos report
Prerequisites
-
You must have the
sospackage installed.
Procedure
- Log into the failing host as a root user.
Perform the debug report creation procedure by running the following command:
$ microshift-sos-report
Example output
sosreport (version 4.5.1) This command will collect diagnostic and configuration information from this Red Hat Enterprise Linux system and installed applications. An archive containing the collected information will be generated in /var/tmp/sos.o0sznf_8 and may be provided to a Red Hat support representative. Any information provided to Red Hat will be treated in accordance with the published support policies at: Distribution Website : https://www.redhat.com/ Commercial Support : https://www.access.redhat.com/ The generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party. No changes will be made to system configuration. Setting up archive ... Setting up plugins ... Running plugins. Please wait ... Starting 1/2 microshift [Running: microshift] Starting 2/2 microshift_ovn [Running: microshift microshift_ovn] Finishing plugins [Running: microshift] Finished running plugins Found 1 total reports to obfuscate, processing up to 4 concurrently sosreport-microshift-rhel9-2023-03-31-axjbyxw : Beginning obfuscation... sosreport-microshift-rhel9-2023-03-31-axjbyxw : Obfuscation completed Successfully obfuscated 1 report(s) Creating compressed archive... A mapping of obfuscated elements is available at /var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-private_map Your sosreport has been generated and saved in: /var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-obfuscated.tar.xz Size 444.14KiB Owner root sha256 922e5ff2db25014585b7c6c749d2c44c8492756d619df5e9838ce863f83d4269 Please send this file to your support representative.
2.3. Additional resources
Chapter 3. Getting support
3.1. Getting support
If you experience difficulty with a procedure described in this documentation, or with MicroShift in general, visit the Red Hat Customer Portal.
From the Customer Portal, you can:
- Search or browse through the Red Hat Knowledgebase of articles and solutions relating to Red Hat products.
- Submit a support case to Red Hat Support.
- Access other product documentation.
3.2. Providing documentation feedback
To report an error or to improve our documentation, log in to your Red Hat Jira account and submit a Jira issue.
3.3. About the Red Hat Knowledgebase
The Red Hat Knowledgebase provides rich content aimed at helping you make the most of Red Hat’s products and technologies. The Red Hat Knowledgebase consists of articles, product documentation, and videos outlining best practices on installing, configuring, and using Red Hat products. In addition, you can search for solutions to known issues, each providing concise root cause descriptions and remedial steps.
3.4. Searching the Red Hat Knowledgebase
In the event of an MicroShift issue, you can perform an initial search to determine if a solution already exists within the Red Hat Knowledgebase.
Prerequisites
- You have a Red Hat Customer Portal account.
Procedure
- Log in to the Red Hat Customer Portal.
- Click Search.
In the search field, input keywords and strings relating to the problem, including:
- MicroShift components (such as etcd)
- Related procedure (such as installation)
- Warnings, error messages, and other outputs related to explicit failures
- Click the Enter key.
- Optional: Select the MicroShift product filter.
- Optional: Select the Documentation content type filter.
3.5. Submitting a support case
Prerequisites
- The MicroShift service is running.
-
You have installed the OpenShift CLI (
oc). - You have a Red Hat Customer Portal account.
- You have a Red Hat Standard or Premium subscription.
Procedure
- Log in to the Customer Support page of the Red Hat Customer Portal.
- Click Get support.
On the Cases tab of the Customer Support page:
- Optional: Change the pre-filled account and owner details if needed.
- Select the appropriate category for your issue, such as Bug or Defect, and click Continue.
Enter the following information:
- In the Summary field, enter a concise but descriptive problem summary and further details about the symptoms being experienced, as well as your expectations.
- Select Red Hat Device Edge from the Product drop-down menu.
- Select 4 from the Version drop-down.
- Review the list of suggested Red Hat Knowledgebase solutions for a potential match against the problem that is being reported. If the suggested articles do not address the issue, click Continue.
- Review the updated list of suggested Red Hat Knowledgebase solutions for a potential match against the problem that is being reported. The list is refined as you provide more information during the case creation process. If the suggested articles do not address the issue, click Continue.
- Ensure that the account information presented is as expected, and if not, amend accordingly.
Complete the following questions where prompted. Include which type of install type you are using, either RPM or embedded-image. Click Continue:
- What are you experiencing? What are you expecting to happen?
- Define the value or impact to you or the business.
- Where are you experiencing this behavior? What environment?
- When does this behavior occur? Frequency? Repeatedly? At certain times?
-
Upload relevant diagnostic data files and click Continue. Include data gathered using the
sostool or etcd as a starting point, plus any issue-specific data that is not collected in those logs. - Add relevant case management details and click Continue.
- Preview the case details and click Submit.
