Skip to content
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.

Sign up for GitHub

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

Jump to bottom

HPCC-33000 Add a Troubleshooting chapter to Containerized manual #19303

Merged
merged 1 commit into from
Dec 9, 2024
Merged

HPCC-33000 Add a Troubleshooting chapter to Containerized manual #19303

merged 1 commit into from
Dec 9, 2024

Conversation

JamesDeFabia
Copy link
Contributor

@JamesDeFabia JamesDeFabia commented Nov 15, 2024 •
edited
Loading

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

https://github.com/JamesDeFabia/github-action-dev-build/actions/runs/11862422016/artifacts/2194787675

@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-33000

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

g-pan
g-pan reviewed Nov 18, 2024
View reviewed changes
Copy link
Member

@g-pan g-pan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

few minor items - inline.

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated
pod status, you can quickly identify and address potential issues,
ensuring the health and performance of your applications.  </para>

<para>The HPCC platform has a pod for each component of a system.</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HPCC Systems platform

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated

<para>This lists all pods in all namespaces.</para>

<para>Each pod should indicate a Status of <emphasis
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Status s/b lower case

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated
<para><programlisting>kubectl get services</programlisting></para>

<para>This lists all services in your cluster, along with their type,
internal and external IP addresses, Port, and Uptime (Age).</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

capitalization ?? should Port and Uptime be init cap?

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated
errors occurring within your application containers. By analyzing these
logs, you can quickly identify and address a wide range of issues.</para>

<para>To view the logs of a specific pod,use the following command in a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add space to pod,use

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated

<para><programlisting>kubectl logs &lt;pod-name&gt; --since=10m</programlisting></para>

<para>filters logs from a specific time.</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Init cap filters?

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated

<variablelist>
<varlistentry>
<term>Check your Helm chart configuration</term>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add period to sentence end.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added periods to all of these.

@JamesDeFabia JamesDeFabia force-pushed the HPCC-33000TroubleshootingChapter branch from fa63834 to 43c88d5 Compare November 19, 2024 18:41
@JamesDeFabia JamesDeFabia requested a review from g-pan November 19, 2024 18:42
@JamesDeFabia JamesDeFabia force-pushed the HPCC-33000TroubleshootingChapter branch from 43c88d5 to 33b465f Compare November 19, 2024 18:43
g-pan
g-pan approved these changes Nov 19, 2024
View reviewed changes
Copy link
Member

@g-pan g-pan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good - approved.

jakesmith
jakesmith reviewed Dec 5, 2024
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JamesDeFabia - looks good in general, a few minor comments.

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated
pod status, you can quickly identify and address potential issues,
ensuring the health and performance of your applications.  </para>

<para>The HPCC Systems platform has a pod for each component of a system.</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. has 1 or more pod corresponding to each component of a deployed system. ?

(e.g. Thor has 2 static agents, and other dynamically launched pods for the manager + workers)

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated

<variablelist>
<varlistentry>
<term>Container Failures </term>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

trivial: extra space after Failures

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml

<para><programlisting>kubectl logs &lt;pod-name&gt;</programlisting></para>

<para>This returns the entire log for a pod.</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how much is returned will depend on the log rotation policy, which I think will depend on the container runtime retention policy.
Just saying, if the pod's logs is GB's long - kubectl logs is unlikely to return it all..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might also be worth noting something about pods with multiple containers. Dali by default has 2 (dali itself and sasha-coalescer). By default kubectl logs will return the logs of the 1st container in the pod.
If you need the logs for a specific container you need to say:
kubectl logs -c

docs/EN_US/ContainerizedHPCC/ContainerizedMods/TroubleshootingHelmDeployments.xml Outdated
<term>Debug application behavior</term>

<listitem>
<para>Examine container logs and events to understand the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is under "By carefully analyzing this information, you can:" , suggesting you can see logs via kubectl describe pod.. - a tad misleading.. since kubectl describe will not show you any logging insights.
You need to run kubectl logs for that...

Maybe delete this listitem, since you have a later section covering logging anyway.

@JamesDeFabia JamesDeFabia force-pushed the HPCC-33000TroubleshootingChapter branch from 33b465f to 35f690b Compare December 5, 2024 13:29
@JamesDeFabia
Copy link
Contributor Author

@jakesmith Made the edits you requested, please have another look

jakesmith
jakesmith approved these changes Dec 5, 2024
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JamesDeFabia - looks good.

@ghalliday ghalliday merged commit 4f515dd into hpcc-systems:candidate-9.8.x Dec 9, 2024
52 checks passed
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 9, 2024

Jirabot Action Result:
Added fix version: 9.8.46
Workflow Transition: 'Resolve issue'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@g-pan g-pan g-pan approved these changes

@jakesmith jakesmith jakesmith approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@JamesDeFabia @jakesmith @g-pan @ghalliday