Update docs and scripts for image generation #11281
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update documentation and scripts to include `UbuntuMinimal` image type and provide customization and troubleshooting information. * **README.md** - Update the list of available images to include `UbuntuMinimal`. - Add a note about customizing the image generation process. - Add a note about troubleshooting issues during the image generation process. * **CONTRIBUTING.md** - Add steps to use the `GenerateResourcesAndImage` script for automating VM image creation. - Add steps to create a Virtual Machine from the generated image using the `CreateAzureVMFromPackerTemplate` script. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/actions/runner-images?shareId=XXXX-XXXX-XXXX-XXXX).
* Add `UbuntuMinimal` to the available images section * Add link to the `UbuntuMinimal` README file in the available images section
* **docs/create-image-and-azure-resources.md** - Add `UbuntuMinimal` to the list of available image types in the manual image generation section. * **images/ubuntu/UbuntuMinimal-Readme.md** - Create a new README file for the `UbuntuMinimal` image. - Add a description of the `UbuntuMinimal` image. - Add a list of installed software for the `UbuntuMinimal` image. - Add a list of environment variables for the `UbuntuMinimal` image.
* Add steps to check logs, validate Packer templates, check Azure resources, review environment variables, check network security settings, verify service principal credentials, check for resource group conflicts, review post-generation scripts, and run tests. * Add references to `GenerateResourcesAndImage` function in `helpers/GenerateResourcesAndImage.ps1` and `CreateAzureVMFromPackerTemplate` script in `helpers/CreateAzureVMFromPackerTemplate.ps1`. * Add note on importance of reviewing "Network Security" section for troubleshooting network security settings.
* **Error Handling**: Add detailed error messages in `helpers/GenerateResourcesAndImage.ps1` to help users understand what went wrong. * **.gitignore**: - Add common OS-specific files to ignore, such as `.DS_Store` for macOS and `Thumbs.db` for Windows. - Include common IDE-specific files, such as `.vscode/`, `.idea/`, and `*.suo` for Visual Studio. - Add entries to ignore build artifacts, such as `bin/`, `obj/`, and `dist/` directories. - Include entries to ignore dependency directories, such as `node_modules/` for Node.js projects and `vendor/` for PHP projects. - Add entries to ignore sensitive files, such as `.env` and `*.key`.
* **Repository Investigation** - Add a new section to document the repository structure, main steps for creating VM images, available image types, customization options, troubleshooting, automation, environment variables, network security, resource group management, adding new tools, and security considerations. - Include subsections for repository structure, detailing various configuration files, GitHub-specific configurations, README.md overview, detailed instructions in docs/create-image-and-azure-resources.md, helper scripts, Packer templates, contributing guidelines, and security policies.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update documentation and scripts to include
UbuntuMinimalimage type and provide customization and troubleshooting information.README.md
UbuntuMinimal.CONTRIBUTING.md
GenerateResourcesAndImagescript for automating VM image creation.CreateAzureVMFromPackerTemplatescript.For more details, open the Copilot Workspace session.