Skip to content

Conversation

@OgnjenPantelic
Copy link

Playbook for creating a Customer-managed VNet. Enables customers to set up a simple, production-grade workspace without additional help from STS.

Pull Request

Description

Brief description of what this PR does and why.
Adds a document playbook for Azure CM VNet with terraform

Category

  • core-platform
  • data-engineering
  • data-governance
  • data-warehousing
  • genai-ml
  • launch-accelerator
  • workspace-setup

Type of Change

  • New project
  • Bug fix
  • Enhancement
  • Documentation

Project Details

Project Name: Azure VNet injection Workspace Setup Guide (Terraform)
Purpose: Customer enablement
Technologies Used: Terraform, Databricks, Azure

Testing

  • Code runs without errors
  • Documentation is complete
  • Used only synthetic data

Security Compliance ✅

  • No customer data, PII, or proprietary information
  • No credentials or access tokens
  • Only synthetic data used
  • Third-party licenses acknowledged

By submitting this PR, I confirm I have followed the CONTRIBUTING.md guidelines and security requirements.

Playbook for creating a Customer-managed VNet. Enables customers to set up a simple, production-grade workspace without additional help from STS.
@jpgianfaldoni
Copy link
Contributor

Do you think it would be better to convert it to markdown instead of docx so it is readable on github/vscode? Any thoughts @andresgarciaf @haleyyyblue?

@haleyyyblue
Copy link
Collaborator

Great question @jpgianfaldoni I’ve been thinking about it, and I believe we should keep the playbook standardization (including format decisions) pending for now since we have other higher-priority backlog items. Let’s focus on TF asset centralization first.
cc @OgnjenPantelic @hemaa-priya

@OgnjenPantelic
Copy link
Author

My reason for using the docx/PDF format is that it is easy to download and share with customers. @gergelj is working on deploying a TF project that aligns with this document. We can add this playbook as a readme file under that, but my personal preference is to have a standalone playbook document for customers to use.
This approach is more of a "document first" than a "code first" approach.
Typically, when sharing a git repo with ready code, customers ask additional questions that are already explained in the README (they just git pull, and don't read the readme half of the time). This document encourages them to read through it and ultimately teaches them about terraform and databricks.

Copy link
Collaborator

@haleyyyblue haleyyyblue left a comment

Choose a reason for hiding this comment

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

I agree with the point that having a PDF version would be useful for customers.
However, before introducing multiple playbooks in different formats, we need to first discuss and establish a standardized framework for how we manage and maintain these playbooks.

If @gergelj and @OgnjenPantelic can integrate the current docx content into a Terraform project’s README.md file, we can review and merge it accordingly.
Simply uploading a docx file to GitHub does not provide version control or collaboration benefits, so I’d prefer to align with the Track Contributors to determine the best long-term approach for managing such documents.

Given that we already have several ongoing workspace setup service projects, setting up a comprehensive playbook management framework may not be feasible within this quarter.
Therefore, I cannot approve this PR at this stage. Instead, I’d like to ask you and @gergelj to start by submitting the Terraform project PR, referring to the GitHub philosophy for alignment.

Until we have a defined management process in place, please continue to manage customer-facing documents in the Content Repo (Confluence) and share PDFs with customers as needed.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants