Usage Guide

This guide provides step-by-step instructions for using Nidra Manager to manage your KubeNidra workloads.

Getting Started

1. Access the Application

Open your web browser and navigate to the Nidra Manager URL:

http://your-nidra-manager-domain

Follow the instructions and generate a JWT token for authentication.

2. Initial Setup

On first access, you'll see the main dashboard. The application will automatically:

• Connect to the KubeNidra API
• Load available namespaces
• Display workloads in the watched namespaces

Basic Operations

📋 Viewing Workloads

1. Select Workload Type: Click on the appropriate tab:

   • Deployments: Most common workload type
   • StatefulSets: Stateful applications
   • DaemonSets: Node-level workloads
   • ReplicaSets: Direct replica set management

2. Review Status: Each workload shows:

   • Name: Workload name
   • Status: Active, Snoozed, or Pinned
   • Replicas: Current replica count
   • Schedule: Wake schedule (if configured)

⚡ Enable KubeNidra

To enable KubeNidra for a workload:

1. Find the Workload: Locate the workload in the list
2. Click Enable: Click the "Enable" button
3. Configure Schedule (Optional):
   • Enter wake schedule (e.g., 09:00-17:00,mon-fri)
   • Click "Save" to apply
4. Confirm: The workload status will update to show it's enabled

Example Schedule Formats:

09:00-17:00,mon-fri    # Weekdays 9 AM to 5 PM
08:00-18:00            # Daily 8 AM to 6 PM
09:00-12:00,mon-wed,fri;13:00-17:00,thu  # Split schedule

😴 Snooze Workload

To manually snooze a workload:

1. Find the Workload: Locate the active workload
2. Click Snooze: Click the "Snooze" button
3. Confirm: Click "Yes" in the confirmation dialog
4. Monitor: Watch the status change to "Snoozed"

⏰ Wake Workload

To wake a snoozed workload:

1. Find the Workload: Locate the snoozed workload
2. Click Wake: Click the "Wake" button
3. Monitor: Watch the status change to "Active"

❌ Disable KubeNidra

To disable KubeNidra for a workload:

1. Find the Workload: Locate the enabled workload
2. Click Disable: Click the "Disable" button (❌ icon)
3. Confirm: Click "Yes" in the confirmation dialog
4. Verify: The workload will be removed from the KubeNidra monitoring scope

Advanced Operations

📅 Schedule Management

Set Wake Schedule

1. Select Workload: Click on a workload to view details
2. Click Schedule: Click the "Schedule" button
3. Enter Schedule: Enter a valid schedule
4. Save: Click "Save" to apply the schedule

Update Schedule

1. Access Schedule: Click the schedule button for an enabled workload
2. Modify: Change the time ranges or days
3. Save: Click "Save" to update the schedule

Remove Schedule

1. Access Schedule: Click the schedule button
2. Clear: Remove the schedule (set input field to blank)
3. Save: Click "Save" to remove the schedule

🎛️ Override Management

Set Temporary Override

1. Select Workload: Click on a workload
2. Click Override: Click the "Override" button
3. Choose Duration: Enter a valid duration or leave blank for permanent override
4. Confirm: Click "Apply" to set the override

Clear Override

1. Find Overridden Workload: Look for workloads with override indicators
2. Click Clear Override: Click the "Clear Override" button
3. Confirm: Click "Yes" to remove the override

📌 State Pinning

Pin Workload

1. Select Workload: Click on a workload
2. Click Pin: Click the "Pin" button
3. Confirm: Click "Apply" to pin the workload

Remove Pin

1. Find Pinned Workload: Look for workloads with pin indicators
2. Click Unpin: Click the "Unpin" button
3. Confirm: Click "Yes" to remove the pin

Monitoring & Analytics

📊 Status Overview

The dashboard provides a quick overview:

• Total Workloads: Total number of KubeNidra-enabled workloads
• Enabled Workloads: Number of workloads that KubeNidra is monitoring
• Active Workloads: Count of currently active workloads
• Snoozed Workloads: Count of snoozed workloads
• Pinned Workloads: Count of pinned workloads

📈 Operation History

To view operation history:

1. Select Workload: Click on a workload to view details
2. View History: Scroll to the "Operation History" section
3. Review Entries: Each entry shows:
   • Timestamp: When the operation occurred
   • Operation Type: Wake, Snooze, Enable, etc.
   • Trigger: Manual or automatic
   • Replicas: Replica count after operation
   • Duration: Time taken for the operation

User Interface Features

🎨 Theme Switching

To switch themes:

1. Find Theme Toggle: Look for the theme button (🌙/☀️ icon)
2. Click to Toggle: Click to switch between light and dark themes
3. Preference Saved: Your choice is automatically saved

📱 Mobile Usage

On mobile devices:

• Swipe Navigation: Swipe between workload type tabs
• Touch-friendly: Large touch targets for all buttons
• Responsive Layout: Automatic layout adjustment
• Simplified Interface: Optimized for small screens

Troubleshooting

🔧 Common Issues

Workload Not Appearing

1. Check Namespace: Ensure you're in the correct namespace
2. Refresh Page: Try refreshing the browser page
3. Check API Connection: Verify the API server is running

Operation Fails

1. Check Error Message: Read the error message carefully
2. Verify Workload Status: Ensure the workload is in the expected state
3. Check Backoff Period: Some workloads may be in backoff
4. Try Again: Wait a moment and try the operation again

🆘 Getting Help

If you encounter issues:

1. Check Logs: Look for error messages in the browser console
2. Review Documentation: Check this usage guide
3. Contact Support: Reach out to your system administrator
4. Report Issues: Report bugs through your organization's process

Best Practices

✅ Recommended Workflows

1. Start Small: Begin with a few test workloads
2. Monitor Closely: Watch the first few operations carefully
3. Set Schedules: Configure appropriate wake schedules
4. Use Pinning: Pin critical workloads to prevent unwanted changes
5. Review History: Regularly check operation history

⚠️ Avoid Common Mistakes

1. Don't Disable Critical Workloads: Be careful when disabling KubeNidra
2. Don't Set Permanent Overrides: Use temporary overrides when possible
3. Don't Ignore Errors: Always read and understand error messages
4. Don't Skip Confirmation: Always confirm destructive operations

🔒 Security Considerations

1. Use HTTPS: Always access the application over HTTPS
2. Log Out: Log out when finished using the application
3. Don't Share Credentials: Keep your access credentials secure
4. Report Suspicious Activity: Report any suspicious behavior