Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move VC to 1.13.0-beta plus document fix for MDX2.0 #209

Merged
merged 5 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pipelines/azure-pipelines-linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ resources:
options: --entrypoint=""

variables:
VcVersion : 1.11.10
VcVersion : 1.13.0
ROOT: $(Build.SourcesDirectory)
CDP_DEFINITION_BUILD_COUNT: $[counter('', 0)] # needed for onebranch.pipeline.version task https://aka.ms/obpipelines/versioning
ENABLE_PRS_DELAYSIGN: 1
Expand Down
2 changes: 1 addition & 1 deletion .pipelines/azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pool:
vmImage: windows-latest

variables:
VcVersion : 1.11.10
VcVersion : 1.13.0
ROOT: $(Build.SourcesDirectory)
CDP_DEFINITION_BUILD_COUNT: $[counter('', 0)] # needed for onebranch.pipeline.version task https://aka.ms/obpipelines/versioning
ENABLE_PRS_DELAYSIGN: 1
Expand Down
12 changes: 0 additions & 12 deletions GitVersion.yml

This file was deleted.

1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![Pull Request Build](https://github.com/microsoft/VirtualClient/actions/workflows/pull-request.yml/badge.svg)](https://github.com/microsoft/VirtualClient/actions/workflows/pull-request.yml)
[![Document Build](https://github.com/microsoft/VirtualClient/actions/workflows/deploy-doc.yml/badge.svg?branch=main)](https://github.com/microsoft/VirtualClient/actions/workflows/deploy-doc.yml)
[![Document Deployment](https://github.com/microsoft/VirtualClient/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/microsoft/VirtualClient/actions/workflows/pages/pages-build-deployment)
[![NuGet Release Status](https://msazure.visualstudio.com/One/_apis/build/status/OneBranch/CRC-AIR-Workloads/microsoft.VirtualClient?branchName=main)](https://msazure.visualstudio.com/One/_build/latest?definitionId=297462&branchName=main)

------

Expand Down
8 changes: 0 additions & 8 deletions website/blog/2022-10-12-release-0-0-1.md

This file was deleted.

14 changes: 13 additions & 1 deletion website/blog/authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,16 @@ yangpanMS:
name: Yang Pan
title: Software Engineer @MSFT
url: https://github.com/yangpanMS
image_url: https://github.com/yangpanMS.png
image_url: https://github.com/yangpanMS.png

brdeyo:
name: Bryan DeYoung
title: Principal Software Engineer Manager @MSFT
url: https://github.com/brdeyo
image_url: https://github.com/brdeyo.png

rashah-microsoft:
name: Rahul Shah
title: Senior Software Engineering Director @MSFT
url: https://github.com/rashah-microsoft
image_url: https://github.com/rashah-microsoft.png
7 changes: 7 additions & 0 deletions website/blog/ocp-summit-2023.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
slug: ocp-summit-2023
title: VirtualClient at OpenComputeProject Summit 2023
authors: [yangpanMS, brdeyo, rashah-microsoft]
tags: [virtualclient, opencomputeproject, ocp]
---

2 changes: 1 addition & 1 deletion website/docs/dependencies/0060-install-mysql-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The following section describes the different options for the 'Action' parameter
| **Action** | **Description** |
|----------------------------|-----------------------------------------------------------------------------------------------------------------|
| StartDatabaseServer | Starts the MySQL server. |
| CreateDatabase | Creates a database under {Database Name} in the MySQL server. |
| CreateDatabase | Creates a database under \<Database Name> in the MySQL server. |
| RaisedStatementCount | Increases number of statements MySQL can prepare (only recommended for larger VMs). |
| ConfigureNetwork | Modifies the configuration file to make MySQL server accessible to the private network of VMs. |
| CreateUser | Creates user access to the server for each client VM in the provided environment layout. |
Expand Down
2 changes: 0 additions & 2 deletions website/docs/developing/0001-ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ covers the details for how to do this.
This build pipeline is not publicly available because it involves Microsoft signing processes. Because of this distinction, pull requests will
always require at least one Microsoft employee to sign off.

[![NuGet Release Status](https://msazure.visualstudio.com/One/_apis/build/status/OneBranch/CRC-AIR-Workloads/microsoft.VirtualClient?branchName=main)](https://msazure.visualstudio.com/One/_build/latest?definitionId=297462&branchName=main)

New releases of the Virtual Client are published to NuGet.org in the following location:
- https://www.nuget.org/packages/VirtualClient
- https://www.nuget.org/packages/VirtualClient.Framework
Expand Down
4 changes: 2 additions & 2 deletions website/docs/developing/0010-develop-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,7 @@ This constructor takes in the following parameters:
Provides all shared/common dependencies required by Virtual Client components (see section above). These core dependencies can be used to interoperate
with the Virtual Client core runtime platform as well as the system on which it is running.

* **IDictionary<string, IConvertible>**
* **IDictionary\<string, IConvertible>**
Provides the parameters defined in the profile for the action, monitor or dependency handler step to the class instance.

#### Component Code/Method Flow
Expand Down Expand Up @@ -815,7 +815,7 @@ euphoria. We typically use the Visual Studio IDE due to its robust support for d
* Set the 'VirtualClient.Main' project as the 'Startup project'.
* Right-click on this project and select 'Properties' from the menu.
* In the 'Debug' section, put the following in for the 'Application arguments':
* --profile=EXAMPLE-WORKLOAD.json --timeout=1440 --packages={{YourBlobStoreSASUri}}
* --profile=EXAMPLE-WORKLOAD.json --timeout=1440 --packages=\<YourBlobStoreSASUri>

* [Example Workload/Test Executor](https://github.com/microsoft/VirtualClient/blob/main/src/VirtualClient/VirtualClient.Actions/Examples/ExampleWorkloadExecutor.cs)
Provides a coded example for how to write a basic workload executor.
Expand Down
5 changes: 0 additions & 5 deletions website/docs/developing/0020-develop-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,7 @@ The following example extensions repo can be used for reference to the details d
* [CRC-VirtualClient-Examples Git Repo](https://msazure.visualstudio.com/One/_git/CRC-VirtualClient-Examples)

## Platform Libraries
In order to develop extensions to the Virtual Client platform, the following libraries are required. These can be referenced or downloaded from the CRC
team's NuGet feeds.

* #### NuGet Feeds
* [Production Release NuGet Feed](https://msazure.visualstudio.com/One/_artifacts/feed/CRC)
* [Pre-Release NuGet Feed](https://msazure.visualstudio.com/One/_artifacts/feed/CRC-Dev)

* #### NuGet Packages/Libraries
* **VirtualClient.Framework**
Expand Down
8 changes: 4 additions & 4 deletions website/docs/developing/0030-workload-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ to packaging workloads and dependencies in easy-to-consume Virtual Client packag
* [Storage Account Support](../guides/0600-integration-blob-storage.md)

## Step 3: Create Parsers and Unit Tests
* Create a parser class file with name <Workload_name>ResultsParser.cs(e.g. WebFundamentalsResultsParser.cs) in project VirtualClient.Parser.
* Write unit tests for the parser created in project VirtualClient.Parser.UnitTests with the name <Workload_name>ResultsParserTests.cs(e.g. WebFundamentalsResultsParserTests.cs)
* Create a parser class file with name \<Workload_name>ResultsParser.cs(e.g. WebFundamentalsResultsParser.cs) in project VirtualClient.Parser.
* Write unit tests for the parser created in project VirtualClient.Parser.UnitTests with the name \<Workload_name>ResultsParserTests.cs(e.g. WebFundamentalsResultsParserTests.cs)
* To store all the required input files for the tests, create a folder with the name of workload in the examples folder in VirtualClient.Parser.UnitTests project.
* Update VirtualClient.Parser.UnitTests.csproj file with the details of example files.

Expand All @@ -43,7 +43,7 @@ to packaging workloads and dependencies in easy-to-consume Virtual Client packag
* Update PackageManagerTests.cs of project VirtualClient.Core.UnitTests to include the unit tests of the changes.

## Step 5: Profile Creation
* Create json file with name PERF-<PERF_CRITERION>-<Workload_Name>.json (eg. PERF-WEB-WEBFUNDAMENTALS.json) in profiles folder of VirtualClient.Main project.
* Create json file with name PERF-\<PERF_CRITERION>-\<Workload_Name>.json (eg. PERF-WEB-WEBFUNDAMENTALS.json) in profiles folder of VirtualClient.Main project.
* This file contains all the dependencies that are required by the workload.
* Dependencies are included in the project VortualClient.Dependencies.
* Update VirtualClient.Main.csproj file and VirtualClient.Actions.FunctionalTests.csproj file with the json file created.
Expand All @@ -62,7 +62,7 @@ to packaging workloads and dependencies in easy-to-consume Virtual Client packag

## Step 7: Dependencies Creation
* In case, Workload requires one time set-up on VM then that can be added as a dependency in the VC.
* Add <Depency_Name>.cs(IISInstallation.cs) file in VirtualClient.Dependencies project.
* Add \<Depency_Name>.cs(IISInstallation.cs) file in VirtualClient.Dependencies project.
* Add its unit tests in project VirtualClient.Dependencies.UnitTests project.
* This dependency can be added in profile file created for workload in VirtualClient.Main.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/guides/0001-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,15 @@ You can find zip files in the latest [GitHub Releases](https://github.com/micros

```powershell
# Example
PM> NuGet\Install-Package VirtualClient -Version 1.11.0
PM> NuGet\Install-Package VirtualClient -Version 1.12.0
```

- If you are on a Windows system, you can download from the command line using the NuGet.exe:
- https://www.nuget.org/downloads

``` bash
# Example
C:\Users\Any> NuGet.exe Install VirtualClient -OutputDirectory C:\Users\Any\nuget\packages -NoCache -Version 1.11.0 -Source nuget.org
C:\Users\Any> NuGet.exe Install VirtualClient -OutputDirectory C:\Users\Any\nuget\packages -NoCache -Version 1.12.0 -Source nuget.org
```

### NuGet/Zip Package Contents
Expand Down
8 changes: 4 additions & 4 deletions website/docs/guides/0010-command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ on the system.
| --p, --profile=\<profile\> | Yes | string/text | The execution profile which indicates the set of workloads to run. |
| --ps, --packages, --packageStore=\<authtoken\> | Yes/No | string/connection string/SAS | A full connection string or SAS URI to an Azure storage account blob store from which workload and dependency packages can be downloaded. This is required for most workloads because the workload binary/script packages are not typically packaged with the Virtual Client application itself. Contact the VC Team to get a SAS URI for your team. See [Azure Storage Account Integration](./0600-integration-blob-storage.md). |
| --a, --agentId, --clientId=\<id\> | No | string/text | An identifier that can be used to uniquely identify the instance of the Virtual Client in telemetry separate from other instances. The default value is the name of the system if this option is not explicitly defined (i.e. the name as defined by the operating system). |
| --port, --api-port=\<port\> | No | integer | The port to use for hosting the Virtual Client REST API service for profiles that allow multi-system, client/server operations (e.g. networking). Additionally, a port may be defined for each role associated with the profile operations using the format {Port}/{Role} with each port/role combination delimited by a comma (e.g. 4501/Client,4502/Server). |
| --port, --api-port=\<port> | No | integer | The port to use for hosting the Virtual Client REST API service for profiles that allow multi-system, client/server operations (e.g. networking). Additionally, a port may be defined for each role associated with the profile operations using the format \{Port}/\{Role} with each port/role combination delimited by a comma (e.g. 4501/Client,4502/Server). |
| --cs, --content, --contentStore=\<authtoken\> | No | string/connection string/SAS | A full connection string or SAS URI to an Azure storage account blob store where files/content can be uploaded as part of background monitoring processes. Contact the VC Team to get a SAS URI for your team. See [Azure Storage Account Integration](./0600-integration-blob-storage.md). |
| --cp, --contentPath, --contentPathTemplate=\<folderPattern\> | No | string/text | The content path format/structure to use when uploading content to target storage resources. When not defined the 'Default' structure is used. Default: "{experimentId}/{agentId}/{toolName}/{role}/{scenario}" |
| --cp, --contentPath, --contentPathTemplate=\<folderPattern\> | No | string/text | The content path format/structure to use when uploading content to target storage resources. When not defined the 'Default' structure is used. Default: "\{experimentId}/\{agentId}/\{toolName}/\{role}/\{scenario}" |
| --eh, --eventHub, --eventHubConnectionString=\<accesspolicy\> | No | string/connection string | A full connection string/access policy for the Azure Event Hub namespace where telemetry should be written. Contact the VC Team to get an access policy for your team. See [Azure Event Hub Integration](./0610-integration-event-hub.md). |
| --e, --experimentId=\<guid\> | No | guid | A unique identifier that defines the ID of the experiment for which the Virtual Client workload is associated. |
| --ff, --fail-fast | No | | Flag indicates that the application should exit immediately on first/any errors regardless of their severity. This applies to 'Actions' in the profile only. 'Dependencies' are ALWAYS implemented to fail fast. 'Monitors' are generally implemented to handle transient issues and to keep running/trying in the background. |
Expand All @@ -25,7 +25,7 @@ on the system.
| --s, --system=\<executionSystem\> | No | string/text | The execution system/platform in which Virtual Client is running (e.g. Azure). |
| --t, --timeout=\<mins_or_timespan\>,deterministic<br/>--timeout=\<mins_or_timespan\>,deterministic\* | No | timespan or integer | Specifies a timespan or the length of time (in minutes) that the Virtual Client should run before timing out and exiting (e.g. 1440, 01.00:00:00). The user can additionally provide an extra instruction to indicate the application should wait for deterministic completions.<br/><br/>Use the '**deterministic**' instruction to indicate the application should wait for the current action/workload to complete before timing out (e.g. --timeout=1440,deterministic).<br/><br/>Use the '**deterministic***' instruction to indicate the application should wait for all actions/workloads in the profile to complete before timing out (e.g. --timeout=1440,deterministic*).<br/><br/> Note that this option cannot be used with the --iterations option.<br/><br/>If neither the --timeout nor --iterations option are supplied, the Virtual Client will run non-stop until manually terminated. |
| --i, --iterations=\<count\> | No | integer | Defines the number of iterations/rounds of all actions in the profile to execute before exiting.<br/><br/> Note that this option cannot be used with the --timeout option. |
| --wt, --exit-wait, --flush-wait=<mins_or_timespan> | No | timespan or integer | Specifies a timespan or the length of time (in minutes) that the Virtual Client should wait for workload and monitor processes to complete and for telemetry to be fully flushed before exiting (e.g. 60, 01:00:00). This is useful for scenarios where Event Hub resources are used to ensure that all telemetry is uploaded successfully before exit. Default = 30 mins. |
| --wt, --exit-wait, --flush-wait=\<mins_or_timespan> | No | timespan or integer | Specifies a timespan or the length of time (in minutes) that the Virtual Client should wait for workload and monitor processes to complete and for telemetry to be fully flushed before exiting (e.g. 60, 01:00:00). This is useful for scenarios where Event Hub resources are used to ensure that all telemetry is uploaded successfully before exit. Default = 30 mins. |
| --dependencies | No | | Flag indicates that only the dependencies defined in the profile should be executed/installed. |
| --debug | No | | If this flag is set, verbose logging will be output to the console. |
| -?, -h, --help | No | | Show help information. |
Expand Down Expand Up @@ -102,7 +102,7 @@ VirtualClient.exe bootstrap --package=anyworkload.1.0.0.zip --name=anyworkload -

| Option | Required | Data Type | Description |
|---------------------|----------|-------------------|-------------|
| --port, --api-port=\<port\> | No | integer | The port to use for hosting the Virtual Client REST API service. Additionally, a port may be defined for the Client system and Server system independently using the format '\{Port\}/\{Role\}' with each port/role combination delimited by a comma (e.g. 4501/Client,4502/Server). |
| --port, --api-port=\<port> | No | integer | The port to use for hosting the Virtual Client REST API service. Additionally, a port may be defined for the Client system and Server system independently using the format `\<Port> / \<Role>` with each port/role combination delimited by a comma (e.g. 4501/Client,4502/Server). |
| --ip, --ipAddress | No | string/IP address | An IPv4 or IPv6 address of a target/remote system on which a Virtual Client instance is running to monitor. The API service must also be running on the target instance. |
| --mon, --monitor | No | | If supplied as a flag (i.e. no argument), the Virtual Client will run a background thread that tests the local API. If an IP address is provided, the target Virtual Client API will be monitored/tested. This is typically used for debugging scenarios to make sure 2 different instances of the Virtual Client can communicate with each other through the API. |
| --debug | No | | If this flag is set, verbose logging will be output to the console. |
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/0030-commercial-workloads.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Run Commercial Workloads: Bring Your Own Package
Virtual Client supports running commercial workloads. However, we can not distribute the binary and licenses for the commercial workloads. In those cases, users need to "bring their own binary and license".

:::warn
:::warning
*The Virtual Client team is currently working to define and document the process for integration of commercial workloads into the Virtual Client.
The contents of this document are NOT complete and are meant only to illustrate the basic concepts. Please bear with us while we are figuring this
process out.*
Expand Down
Loading