achurchard/robustness

.github/CODEOWNERS

@@ -288,6 +288,8 @@
 
 /src/alb/ @jaishals
 
+/src/azext_aosm/ @jddarby
+
 /src/managedccfs/ @msftsettiy
 
 /src/acrquery/ @CarolineNB

.github/workflows/BuildAOSMWheel.yml

@@ -0,0 +1,31 @@
+on:
+  push:
+    branches:
+      - add-aosm-extension
+
+jobs:
+  build_aosm:
+    runs-on: ubuntu-latest
+    container: mcr.microsoft.com/azure-cli/tools:latest
+    permissions: write-all
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Build AOSM Wheel
+        run: |
+          # Pretend we have a valid git repo to satisfy azdev.
+          mkdir .git
+          azdev setup -r .
+          azdev extension build aosm
+      - name: Upload AOSM Wheel
+        uses: actions/upload-artifact@v3
+        with:
+          name: aosm-extension
+          path: dist/*.whl
+      - name: Update Release
+        uses: pyTooling/Actions/releaser@r0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: |
+            dist/*.whl
+          tag: aosm-extension

.github/workflows/CheckStyleAndLinting.yml

@@ -0,0 +1,18 @@
+name: Style and Lint Check
+
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  build_aosm:
+    runs-on: ubuntu-latest
+    container: mcr.microsoft.com/azure-cli/tools:latest
+    permissions: write-all
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Check Style
+        run: azdev style aosm
+      - name: Check Linting
+        run: azdev linter aosm

src/aosm/HISTORY.rst

@@ -0,0 +1,30 @@
+.. :changelog:
+
+Release History
+===============
+
+unreleased
+++++++++++
+* `az aosm nfd build` options `--order-params` and `--interactive` to help users choose which NF parameters to expose as deployParameters. Feature added that allows CNF value mappings file to be generated if none is supplied.
+* NFDV version exposed as a CGV on an SNS.
+* `az aosm nfd publish` option added for `--definition-type cnf` to publish the CNF bicep templates, upload helm charts from disk to the ACR and copy the images from a source ACR to the target ACR.
+* Managed Identity added to VNF NF templates - requires subscription to be registered for the feature flag.
+* Various fixes to NFD build of deployParameters schema and interactive mode create of deployParameters mappings file.
+* Fix CNF NFD publish so that it doesn't render the ACR unuseable for future Artifact publishing.
+* Allow CNF NFD image copy from a source ACR using a namespace.
+* Fix - Add new CGSchema parameters not from the NFD to the `required` section of the schema.
+* Add the ability to skip bicep publish or artifact upload during publish commands.
+* Fix Manifest name for NSDs so it isn't the same as that for NFDs
+* Add validation of source_registry_id format for CNF configuration
+
+0.2.0
+++++++
+Breaking change to commands - now use `nfd` instead of `definition`. Publish option removed from build.
+* `az aosm nfd generate-config` for vnf and cnf. This is for NFDVs
+* `az aosm nfd build|publish|delete --definition-type vnf|cnf` for vnf and `build` only for cnf. This is for NFDVs
+
+0.1.0
+++++++
+* Initial release - alpha quality
+    * `az aosm definition generate-config` for vnf and cnf. This is for NFDVs
+    * `az aosm definition build|publish|delete` for vnf and `build` only for cnf. This is for NFDVs

src/aosm/README.md

@@ -0,0 +1,177 @@
+# Microsoft Azure CLI 'aosm' Extension
+
+This package is for the 'aosm' extension to support Azure Operator Service Manager 
+functions.
+i.e. `az aosm`
+
+## Background
+
+The `az aosm` extension is intended to provide support for working with AOSM
+resources and definitions. Currently it only implements commands which aid the
+process of publishing Network Function Definitions and Network Service Designs to
+use with Azure Operator Service Manager or Network Function Manager.
+
+## Installation
+
+Eventually the extension will be published through the usual process and it will be
+installed as usual, via `az extension add --name aosm`
+
+Until then, the latest development version can be found here:
+https://github.com/jddarby/azure-cli-extensions/releases/download/aosm-extension/aosm-0.2.0-py2.py3-none-any.whl
+
+To install, download this wheel and run:
+`az extension add --source path/to/aosm-0.2.0-py2.py3-none-any.whl`
+
+## Updating 
+
+We are currently not bumping versions, so if you would like the most up to date version of the CLI. You should run:
+'az extension remove --name aosm'
+
+And then re-add with the new wheel, as detailed in Installation above. 
+
+## Bug Reporting
+
+Especially as this extension is still in development, you may encounter bugs or
+usability issues as you try to use it in its current form. It would be much
+appreciated if you could report these so that we're aware of them!
+
+The (Microsoft internal) process for bug reporting during development is here:
+https://eng.ms/docs/strategic-missions-and-technologies/strategic-missions-and-technologies-organization/azure-for-operators/aiops/aiops-orchestration/aosm-product-docs/processes/bug_process
+
+CLI issues should be tagged and triaged as UX bugs.
+
+## nfd and nsd commands
+
+These commands help with the publishing of Network Function Definition and Network
+Service Design resources.
+
+## Overview of function
+A generic workflow of using the tool would be:
+- Find the pre-requisite items you require for your use-case
+- Run a `generate-config` command to output an example JSON config file for subsequent commands
+- Fill in the config file
+- Run a `build` command to output one or more bicep templates for your Network Function Definition or Network Service Design
+- Review the output of the build command, edit the output as necessary for your requirements
+- Run a `publish` command to:
+    * Create all pre-requisite resources such as Resource Group, Publisher, Artifact Stores, Groups
+    * Deploy those bicep templates
+    * Upload artifacts to the artifact stores
+
+### Pre-requisites
+
+#### VNFs
+
+For VNFs, you will need a single ARM template which would create the Azure resources
+for your VNF, for example a Virtual Machine, disks and NICs. You'll also need a VHD
+image that would be used for the VNF Virtual Machine.
+
+#### CNFs
+
+For CNFs you must have the `helm` package installed on the machine you are running the CLI from. Instructions on how to do this can be found [here](https://helm.sh/docs/intro/install/).
+
+For CNFs, you must provide:
+* helm packages with an associated schema. These files must be on your disk and will be referenced in the `input.json` config file. 
+* a reference to an existing Azure Container Registry which contains the images for your CNF. Currently, only one ACR is supported per CNF. The images to be copied from this ACR are populated automatically based on the helm package schema.
+* optionally, you can provide a file (on disk) path_to_mappings which is a copy of values.yaml with your chosen values replaced by deployment parameters, thus exposing them as parameters to the CNF. You can get this file auto-generated by leaving the value as a blank string, either having every value as a deployment parameter, or using `--interactive` to interactively choose.
+When filling in the input.json file, you must list helm packages in the order they are to be deployed. For example, if A must be deployed before B, your input.json should look something like this:
+
+        "helm_packages": [
+            {
+                "name": "A",
+                "path_to_chart": "Path to package A",
+                "path_to_mappings": "Path to package A mappings",
+                "depends_on": [
+                    "Names of the Helm packages this package depends on"
+                ]
+            },
+            {
+                "name": "B",
+                "path_to_chart": "Path to package B",
+                "path_to_mappings": "Path to package B mappings",
+                "depends_on": [
+                    "Names of the Helm packages this package depends on"
+                ]
+            },
+
+#### NSDs
+For NSDs, you will need to have a Resource Group with a deployed Publisher, Artifact Store, Network Function Definition and Network Function Definition Version. You can use the `az aosm nfd` commands to create all of these resources.
+
+
+### Command examples
+
+#### NFDs
+
+Get help on command arguments
+
+`az aosm -h`
+`az aosm nfd -h`
+`az aosm nfd build -h`
+etc...
+
+All these commands take a `--definition-type` argument of `vnf` or `cnf`
+
+Create an example config file for building a definition
+
+`az aosm nfd generate-config`
+
+This will output a file called `input.json` which must be filled in. 
+Once the config file has been filled in the following commands can be run.
+
+Build an nfd definition locally
+
+`az aosm nfd build --config-file input.json`
+
+More options on building an nfd definition locally:
+
+Choose which of the VNF ARM template parameters you want to expose as NFD deploymentParameters, with the option of interactively choosing each one.
+
+`az aosm nfd build --config-file input.json --definition_type vnf --order_params`
+`az aosm nfd build --config-file input.json --definition_type vnf --order_params --interactive`
+
+Choose which of the CNF Helm values parameters you want to expose as NFD deploymentParameters.
+
+`az aosm nfd build --config-file input.json --definition_type cnf [--interactive]`
+
+Publish a pre-built definition
+
+`az aosm nfd publish --config-file input.json`
+
+Delete a published definition
+
+`az aosm nfd delete --config-file input.json`
+
+Delete a published definition and the publisher, artifact stores and NFD group
+
+`az aosm nfd delete --config-file input.json --clean`
+
+#### NSDs
+
+Get help on command arguments
+
+`az aosm -h`
+`az aosm nsd -h`
+`az aosm nsd build -h`
+etc...
+
+Create an example config file for building a definition
+
+`az aosm nsd generate-config`
+
+This will output a file called `input.json` which must be filled in. 
+Once the config file has been filled in the following commands can be run.
+
+Build an nsd locally
+
+`az aosm nsd build --config-file input.json`
+
+Publish a pre-built design
+
+`az aosm nsd publish --config-file input.json`
+
+Delete a published design
+
+`az aosm nsd delete --config-file input.json`
+
+Delete a published design and the publisher, artifact stores and NSD group
+
+`az aosm nsd delete --config-file input.json --clean`

src/aosm/azext_aosm/__init__.py

@@ -0,0 +1,30 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core import AzCommandsLoader
+
+from azext_aosm._help import helps  # pylint: disable=unused-import
+
+
+class AosmCommandsLoader(AzCommandsLoader):
+    def __init__(self, cli_ctx=None):
+        from azure.cli.core.commands import CliCommandType
+
+        aosm_custom = CliCommandType(operations_tmpl="azext_aosm.custom#{}")
+        super().__init__(cli_ctx=cli_ctx, custom_command_type=aosm_custom)
+
+    def load_command_table(self, args):
+        from azext_aosm.commands import load_command_table
+
+        load_command_table(self, args)
+        return self.command_table
+
+    def load_arguments(self, command):
+        from azext_aosm._params import load_arguments
+
+        load_arguments(self, command)
+
+
+COMMAND_LOADER_CLS = AosmCommandsLoader

src/aosm/azext_aosm/_client_factory.py

@@ -0,0 +1,32 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core.commands.client_factory import get_mgmt_service_client
+from azure.cli.core.profiles import ResourceType
+from azure.mgmt.containerregistry import ContainerRegistryManagementClient
+
+from .vendored_sdks import HybridNetworkManagementClient
+
+
+def cf_aosm(cli_ctx, *_) -> HybridNetworkManagementClient:
+    return get_mgmt_service_client(cli_ctx, HybridNetworkManagementClient)
+
+
+def cf_resources(cli_ctx, subscription_id=None):
+    return get_mgmt_service_client(
+        cli_ctx, ResourceType.MGMT_RESOURCE_RESOURCES, subscription_id=subscription_id
+    )
+
+
+def cf_acr_registries(cli_ctx, *_) -> ContainerRegistryManagementClient:
+    """
+    Returns the client for managing container registries.
+
+    :param cli_ctx: CLI context
+    :return: ContainerRegistryManagementClient object
+    """
+    return get_mgmt_service_client(
+        cli_ctx, ResourceType.MGMT_CONTAINERREGISTRY
+    ).registries