​

Infrastructure Onboarding

​

Use Case Overview

• Onboarding new engineers
• Training new team members
• Explaining infrastructure to stakeholders
• Documenting architecture for future reference
• Knowledge transfer sessions

​

Workflow

​

Step 1: Prepare Infrastructure Documentation

1. Upload ARM template or Bicep file to Cloudeval
2. Generate diagram - Automatic visualization of infrastructure
3. Review and customize - Adjust layout for clarity
4. Add annotations - Highlight important components

​

Step 2: Create Interactive Guide

1. Use AI Chat - Prepare common questions and answers
2. Create walkthrough - Guide new users through infrastructure
3. Add context - Explain business logic and decisions
4. Document patterns - Show common architecture patterns

​

Step 3: Share with New Team Members

1. Export diagrams - PNG, PDF, or shareable links
2. Create documentation - Combine diagrams with explanations
3. Share access - Give team members access to Cloudeval project
4. Schedule walkthrough - Live session to explain architecture

​

Step 4: Enable Self-Service Learning

1. Enable AI Chat - Let new members ask questions
2. Provide examples - Show common queries
3. Document workflows - How infrastructure is used
4. Create FAQ - Common questions and answers

​

Key Features for Onboarding

​

Visual Diagrams

• Quick Understanding - See entire infrastructure at a glance
• Relationships - Understand how components connect
• Dependencies - See what depends on what
• Grouping - Resources organized logically

• High-level architecture overview
• Detailed component deep-dives
• Network topology visualization
• Resource group organization

​

Interactive Exploration

• Ask Questions - “What does this resource do?”
• Explore Relationships - “What depends on this storage account?”
• Understand Purpose - “Why is this configured this way?”
• Learn Patterns - “Show me all load balancers”

"What resources are in the production environment?"
"Show me all databases and their connections"
"What is the purpose of this virtual network?"
"Which resources handle user authentication?"

​

Custom Annotations

• Labels - Name important components
• Notes - Explain design decisions
• Highlights - Mark critical resources
• Groupings - Organize by function

• Label: “User Authentication Service”
• Note: “Handles all user login requests”
• Highlight: Critical production resources
• Group: “Frontend Services”, “Backend Services”, “Data Layer”

​

Export for Documentation

• PNG - For presentations and documents
• PDF - For comprehensive documentation
• SVG - For scalable graphics
• Shareable Links - For interactive access

• Onboarding documentation
• Architecture decision records (ADRs)
• Runbooks and playbooks
• Stakeholder presentations

​

Onboarding Scenarios

​

Scenario 1: New DevOps Engineer

1. Share Cloudeval project with new engineer
2. Start with overview - High-level architecture diagram
3. Explore components - Use AI Chat to ask questions
4. Deep dive - Focus on their area of responsibility
5. Review security - Understand security configurations
6. Practice - Let them explore and ask questions

• Visual diagrams
• AI Chat
• Security analysis
• Export for notes

​

Scenario 2: Non-Technical Stakeholder

1. Create simplified diagram - Hide technical details
2. Add business context - Explain business impact
3. Use annotations - Label with business terms
4. Export presentation - PDF or PNG for meetings
5. Walk through - Live session to explain

• Simplified diagrams
• Custom annotations
• Export to PDF
• Presentation mode

​

Scenario 3: Knowledge Transfer

1. Upload all templates - Complete infrastructure
2. Generate comprehensive diagrams - All environments
3. Document with AI Chat - Answer common questions
4. Create FAQ - Common questions and answers
5. Export documentation - Complete reference guide
6. Share with team - Accessible documentation

• Multiple diagrams
• AI Chat documentation
• Export to PDF
• Shareable links

​

Best Practices

​

Start Simple

• High-Level First - Start with overview, then details
• Progressive Disclosure - Add complexity gradually
• Focus Areas - Start with relevant areas
• Build Context - Explain why before what

​

Make It Interactive

• Encourage Questions - Use AI Chat actively
• Explore Together - Live walkthrough sessions
• Self-Service - Let them explore independently
• Practice - Hands-on exploration

​

Keep It Updated

• Regular Updates - Update diagrams when infrastructure changes
• Version Control - Track changes over time
• Document Changes - Explain what changed and why
• Archive Old Versions - Keep history for reference

​

Combine with Other Resources

• Code Comments - Link to code documentation
• Runbooks - Connect to operational procedures
• ADRs - Link to architecture decision records
• Training Materials - Combine with training docs

​

Example Onboarding Flow

​

Day 1: Overview

1. Welcome session - Introduction to team and tools
2. Infrastructure overview - High-level Cloudeval diagram
3. Key components - Identify critical resources
4. Access setup - Give Cloudeval access
5. Self-exploration - Let them explore with AI Chat

​

Day 2-3: Deep Dive

1. Component deep-dives - Detailed exploration of each area
2. Relationships - Understand dependencies
3. Security review - Security configurations
4. Cost overview - Infrastructure costs
5. Q&A sessions - Answer questions

​

Week 2: Hands-On

1. Practice tasks - Make small changes
2. Review changes - See impact in diagrams
3. Collaboration - Work with team
4. Documentation - Create their own notes
5. Feedback - Share what helped/hindered

​

Integration with Onboarding Process

​

Combine with Other Tools

• Confluence/Wiki - Embed Cloudeval diagrams
• Slack/Teams - Share diagrams in channels
• Training Platforms - Include in training materials
• Documentation Sites - Embed in docs

​

Track Progress

• Completion - Track onboarding completion
• Understanding - Assess comprehension
• Feedback - Collect improvement suggestions
• Metrics - Measure onboarding effectiveness

​

Next Steps

• Getting Started Guide - Learn Cloudeval basics
• AI Chat Tutorial - Master AI assistant
• Export & Share - Share diagrams
• Code Reviews - Related use case