[Workflow Name]

Overview

[Provide a brief 1-2 sentence description of what this workflow accomplishes and when it should be used.]

Prerequisites

• [ ] Access Requirements
• [List required permissions/roles]

• [Required API tokens or credentials]

• [ ] Tools and Software

• [Required CLI tools and versions]

• [Required software dependencies]

• [ ] Knowledge Requirements

• [Concepts user should understand]
• [Related workflows they should know]

Steps

1. [First Major Step]

[Provide context for why this step is necessary]

# Example command with explanation
command --with --options

Expected Output:

[Show what successful output looks like]

2. [Second Major Step]

[Explain what this step accomplishes]

# Example command
command --with --options

Note: [Include any important notes or warnings]

3. [Third Major Step]

[Continue with remaining steps...]

Validation

After completing this workflow, verify success by:

1. Check [Resource/Status]
   bash # Validation command kubectl get [resource] -n [namespace]

2. Verify [Functionality]

3. [How to test the functionality works]

4. [Expected behavior to observe]

5. Review Logs
   bash # Check logs for errors kubectl logs -n [namespace] [pod-selector]

Troubleshooting

Common Issues

[Issue 1 Title]

Symptoms:
- [List of symptoms]

Cause:
[Explanation of root cause]

Solution:

# Commands to fix the issue

[Issue 2 Title]

Symptoms:
- [List of symptoms]

Cause:
[Explanation of root cause]

Solution:
[Step-by-step resolution]

Debug Commands

# Useful debugging commands
kubectl describe [resource]
kubectl logs [pod] --previous
kubectl exec -it [pod] -- /bin/bash

Rollback Procedure

If you need to undo this workflow:

1. [Rollback Step 1]
   bash # Rollback command

2. [Rollback Step 2]
   bash # Additional rollback commands

Security Considerations

• [List any security implications]
• [Required security reviews]
• [Compliance requirements]

Performance Impact

• Expected Duration: [Time estimate]
• Resource Usage: [CPU/Memory impact]
• Downtime: [Any expected downtime]

Related Workflows

• [Link to prerequisite workflow]
• [Link to follow-up workflow]
• [Link to alternative approach]

References

• [Link to design document]
• [Link to API documentation]
• [Link to architecture diagram]

Last Updated: [Date]
Author: [Your Name]
Review Status: [Draft/Reviewed/Approved]