You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/azure_jumpstart_ag/contoso_hypermarket/deployment/_index.md
+12-9
Original file line number
Diff line number
Diff line change
@@ -141,15 +141,18 @@ Once automation is complete, users can immediately start enjoying the Contoso Hy
141
141
```
142
142
143
143
- Edit the [main.parameters.json](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_ag/contoso_hypermarket/bicep/main.parameters.json) template parameters file and supply some values for your environment.
144
-
- _`tenantId`_ - Your Azure tenant id
145
-
- _`windowsAdminUsername`_ - Client Windows VM Administrator username
146
-
- _`windowsAdminPassword`_ - Client Windows VM Password. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long.
147
-
- _`deployBastion`_ - Option to deploy using Azure Bastion instead of traditional RDP. Set to _`true`_ or _`false`_.
148
-
- _`fabricCapacityAdmin`_ - Microsoft Fabric capacity admin (admin user ins the same Entra ID tenant).
149
-
<!-- - _`deployGPUNodes`_ - Option to deploy GPU-enabled worker nodes for the K3s clusters. -->
150
-
- _`k8sWorkerNodesSku`_ The K3s worker nodes VM SKU.
151
-
152
-
<!-- - _`k8sWorkerNodesSku`_ The K3s worker nodes VM SKU. If _`deployGPUNodes`_ is set to true, a GPU-enabled VM SKU needs to be provided in this parameter (Example: _`Standard_NV6ads_A10_v5`_). -->
| _`windowsAdminUsername`_| string | Client Windows VM Administrator username | agora |
149
+
| _`windowsAdminPassword`_| string | Client Windows VM Password. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long. ||
150
+
| _`deployBastion`_ | boolean | Option to deploy using Azure Bastion instead of traditional RDP. Set to _`true`_ or _`false`_. |false|
151
+
| _`fabricCapacityAdmin`_ | string | Microsoft Fabric capacity admin (admin user in the same Entra ID tenant). ||
152
+
| _`k8sWorkerNodesSku`_ | string | The K3s worker nodes VM SKU. | Standard_D8s_v5 |
153
+
| _`customLocationRPOID`_ | string | The Azure Custom Location Resource Provider Object ID ||
154
+
| _`sshRSAPublicKey`_ | string | Your SSH Public Key ||
155
+
| _`deployGPUNodes`_ | boolean | Whether or not to deploy K3s worker nodes with GPUs. Set to _`true`_ or _`false`_. |false|
153
156
154
157
Copy file name to clipboardexpand all lines: docs/azure_jumpstart_ag/contoso_motors/deployment/_index.md
+13-8
Original file line number
Diff line number
Diff line change
@@ -148,14 +148,19 @@ Once automation is complete, users can immediately start enjoying the Contoso Mo
148
148
az bicep upgrade
149
149
```
150
150
151
-
- Edit the [main.parameters.json](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_ag/contoso_motors/bicep/main.parameters.json) template parameters file and supply some values for your environment.
152
-
- _`spnClientId`_ - Your Azure service principal application id
153
-
- _`spnClientSecret`_ - Your Azure service principal secret
154
-
- _`spnObjectId`_ - Your Azure service principal id
155
-
- _`spnTenantId`_ - Your Azure tenant id
156
-
- _`windowsAdminUsername`_ - Client Windows VM Administrator username
157
-
- _`windowsAdminPassword`_ - Client Windows VM Password. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long.
158
-
- _`deployBastion`_ - Option to deploy using Azure Bastion instead of traditional RDP. Set to _`true`_ or _`false`_.
151
+
- Edit the [main.parameters.json](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_ag/contoso_motors/bicep/main.parameters.json) template parameters file and supply values for your environment.
| _`spnClientId`_ | string | Your Azure service principal application id ||
156
+
| _`spnClientSecret`_ | securestring | Your Azure service principal secret ||
157
+
| _`spnObjectId`_ | string | Your Azure service principal id ||
158
+
| _`spnTenantId`_ | string | Your Azure tenant id ||
159
+
| _`windowsAdminUsername`_ | string | Client Windows VM Administrator username ||
160
+
| _`windowsAdminPassword`_ | securestring | Client Windows VM Password. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long. ||
161
+
| _`deployBastion`_ | boolean | Option to deploy using Azure Bastion instead of traditional RDP. Set to _`true`_ or _`false`_. |false|
162
+
| _`sshRSAPublicKey`_ | string | Your SSH Public Key ||
163
+
| _`customLocationRPOID`_ | string | The Azure Custom Location Resource Provider Object ID ||
159
164
160
165
- To get the `spnObjectId`, you can run do so using either Azure CLI or Azure PowerShell.
Copy file name to clipboardexpand all lines: docs/drops_contribution_guidelines/_index.md
+3-108
Original file line number
Diff line number
Diff line change
@@ -22,81 +22,7 @@ The **"Create Drop"** wizard simplifies the contribution process by guiding cont
22
22
23
23
To submit a Drop using this method, follow the step-by-step guide below:
24
24
25
-
#### Step 1: Access the Jumpstart Drop Creation Wizard
26
-
27
-
1. Open your preferred web browser.
28
-
2. Go to the Jumpstart Drops [site](https://jumpstart.azure.com/azure_jumpstart_drops).
29
-
3. Select the **Create a Drop** button.
30
-
31
-
32
-
33
-
#### Step 2: Start the Wizard
34
-
35
-
When the page loads, you will be greeted with a welcome screen that introduces the Jumpstart Drop creation process. The wizard consists of three main components:
36
-
37
-
1. Top bar: It displays the progress of the two steps (Card details and Side panel details) and includes the **Create** button to submit the Drop.
38
-
2. Left-side preview bar: This allows you to preview how the content will be rendered once the Drop is approved and published.
39
-
3. Right-side content bar: This is where you input all the required information for the Drop submission.
40
-
41
-
42
-
43
-
#### Step 3: Define the Card Details
44
-
45
-
In this step, you will need to input the data used to fill the [Drop JSON scheme](https://github.com/Azure/arc_jumpstart_drops/blob/main/SCHEMA.md). This data will be used to create the Drop definition file under the [drops](https://github.com/Azure/arc_jumpstart_drops/blob/main/drops) folder.
46
-
47
-
1. Choose the GitHub hosting repository:
48
-
49
-
-**Create in Jumpstart Drops GitHub repository**: In this case, all the source code and documentation of the Drop will be hosted inside the Jumpstart Drops [repo](https://github.com/Azure/arc_jumpstart_drops). Contributors will be able to use the **Side panel details** section to create the documentation of the Drop.
50
-
-**Create in personal GitHub repository**: In this case, the source code and documentation of the Drop will be hosted in the contributor's GitHub repo, and the Drop schema will have a reference to the external repository. If you choose this option, the **Side panel details** section will preview the content from the GitHub repo, but the documentation wizard creator will not be available.
51
-
52
-
For more information, see [Define source code hosting](#step-3-define-the-card-details).
53
-
54
-
2. Choose the creation process:
55
-
56
-
-**Create with step-by-step guidance:** In this case, you will be guided through the Wizard fields to complete all the required information.
57
-
-**Create with existing JSON schema**: Alternatively, you can upload a previously completed JSON definition. This option offers more flexibility but may be more prone to errors. If the JSON is uploaded, some checks will run to ensure the correct definition, and if it's correct, all the Wizard fields will be auto populated.
58
-
59
-
3. Input and review all parameters. For more information about each input, refer to the [Drops definition](https://github.com/Azure/arc_jumpstart_drops/blob/main/SCHEMA.md). Each input has a tooltip with further details and validation to ensure accurate inputs.
60
-
As you fill in the parameters, you'll see that the top bar will show the status (In Progress or Completed).
61
-
62
-
63
-
64
-
4. Preview Card details: Validate that the Drop Card is rendering correctly and that the provided information is clear and informative. Note that the action buttons such as Downloads or Share will not work in this preview.
65
-
66
-
67
-
68
-
5. After completing the **Card details** section, you can proceed to the **Side panel details** section. If you are hosting the Drop in the Jumpstart Drops GitHub repository, this section will provide a Wizard to create the documentation. However, if you are using an external repository, the section will render the content from the submitted repository as the source for the Drop.
69
-
70
-
71
-
72
-
6. Choose the creation process for the side panel content:
73
-
74
-
-**Create with step-by-step guidance**: This option will guide you through the process of creating the side panel content by providing step-by-step instructions.
75
-
-**Upload Existing asset**: If you already have the side panel content prepared, you can upload it directly using this option.
76
-
77
-
7. The **Side panel details** creation process follows a similar approach to the **Card details** creation process. As you input all the information or submit pre-created files, you can preview the content in the right-side preview bar. The step-by-step guide aims to simplify the documentation creation process by suggesting certain sections for contributors. However, please note that this documentation can always be modified after the Drop is submitted and published. For more flexibility, you can also create an **_index.md** markdown file locally and upload it for the final submission.
78
-
79
-
As you submit all content, you'll notice that the top bar will indicate that the section is **In progress**.
80
-
81
-
82
-
83
-
8. Once all the content is submitted and reviewed, you will notice that the two sections of the progress bar will turn green, indicating that all required information has been provided. At this point, you can proceed by clicking the **Create Drop** button. If everything is correct, both sections of the progress bar will turn green, indicating successful data for submission followed by redirection to the final page, where you can view the status of submission.
84
-
85
-
86
-
87
-
> **Note:** If there are any missing inputs or parameters, the progress bar will turn red, and the Drop creation process will be halted. In such cases, please review the content and ensure that all errors are fixed.
88
-
89
-
90
-
91
-
9. Complete the submission and wait for the content to be processed. The Drop Creation Wizard will automate the creation of a GitHub pull request. Once the pull request is created, a link to the public PR will be provided for the contributor to track the status of the Drop. If any additional content or comments need to be added, they can be done by commenting directly on the GitHub PR or by creating an [issue](https://github.com/Azure/arc_jumpstart_drops/issues).
92
-
93
-
94
-
95
-
Once the process is complete and the pull request is created, you will receive a successful message along with a link to review the PR.
96
-
97
-
98
-
99
-
10. Once the pull request is created, the review and submission process is the same as the process discussed below for the **Manual PR creation approach**. The appropriate checks and review process will take place by the Jumpstart team, and after the review feedback loop, the Drop will be published. For more information, check the **Contribution process flow** below.
@@ -159,41 +85,10 @@ The final submission should contain the following files:
159
85
160
86
## Drop Index
161
87
162
-
When you select a Drop for more information, a right-sidebar will appear, displaying a more detailed view of the Drop. The content of the right bar is based on the *_README.md_ or _Index.md_ file of the Drop's source code, which is used to render different sections. To ensure that the right bar displays all the relevant information, headers (H2, H3, or H4) must be included in the _README.md_ or _Index.md_ file.
163
-
164
-
165
-
166
-
When accessing the right-sidebar, you'll be presented with the following sections:
167
-
168
-
1.**Metadata header**: This section will display important information from the Drop JSON schema file, allowing you to quickly and easily access key details about your Drop data.
169
-
2.**Section selector**: A dropdown menu will enable you to choose from different sections of the Drop Index file, making it easy to navigate through the Drop documentation.
170
-
3.**Selected content**: Once you've chosen a section, the content will be displayed, allowing you to view the information you need without having to navigate away from the page.
171
-
4.**Full-screen mode**: If you need more space to work with, you can switch to full-screen mode with the click of a button, giving you a larger view of your data and making it easier to work with.
172
-
173
-
To help contributors write effective documentation for their Drop Index page, we recommend including the following sections:
174
-
175
-
-**Overview**: This section should provide a detailed description of the Drop, including any important notes or information that users need to be aware of before running it.
176
-
-**Prerequisites**: This section should list all the prerequisites that need to be configured before running the Drop. For each prerequisite, we encourage authors to be descriptive about the specific version (if needed) and provide appropriate documentation links on how to configure it.
177
-
-**Getting Started**: This section should provide detailed instructions on how to run the Drop, including a quick start approach and coverage of the different configurations and parameters available. This section assumes that the prerequisites are already satisfied. If there's a way to run the Drop with one command, we recommend including it and explaining the different variables/parameters that could be used.
178
-
-**Resources**: This section should list resources that users can use to find helpful information regarding the Drop and the products/prerequisites used.
179
-
-**Others**: This section will render the content for all other headers that don't match the above.
180
-
181
-
It's important to note that while the sections described above are recommended for an optimal user experience, contributors are free to use their own layouts and sections. If no matching sections are found, all content will be rendered in a single tab labeled **Overview**.
182
-
183
-
For example, if the **Manage Extended Security Updates (ESU) licenses at scale** contains an _index.md_ that contains the _Overview_, _Contributors_, _Prerequisites_, _Getting started_ and _Resources_ sections, the right-bar will render as the following image:
The folder structure guidelines for submitting Drop source code as part of a Pull Request into the Arc Jumpstart Drops repository are as follows:
192
93
193
-
1. Create a root folder with the name of the Drop using **snake_case**. For example, *azure_arc_management_and_monitor_workbook*.
194
-
195
-
2. Inside the root folder, include a file named *_index.md* that serves as a README file for the Drop. This file should provide a brief introduction and overview of the Drop, its objectives, prerequisites, deployment steps, and any additional resources or references.
196
-
197
-
3. Create a new folder named *artifacts* inside the root folder. This folder should contain all the files and scripts necessary to run the Drop.
198
-
199
-
4. Optionally, create a new folder named *media* inside the artifacts folder. This folder can contain any screenshots or architecture diagrams that showcase the Drop.
0 commit comments