Skip to content

Commit

Permalink
AZ AOSM Extension Refactor (#7429)
Browse files Browse the repository at this point in the history
* Merge Temp mavenir wheel into MAIN (#135)

* added empty template parser

* Initial scaffolding of some new classes

* added utils, added base builder + reader + their children, added nfd and vhd processors

* moved utils to common folder + added local file builder

* Add some basic implementations

* add new commands and restructure command groups

* better naming for command groups

* revert addition on the onboard command group

* update HISTORY.rst

* fix style issue

* fix linting issues

* added empty vhd and nfd processors; moved client factory from old repo

* Add template parser interface (BaseParser)

* Add parameters to BaseParser

* Make defaults_path optional in base_parser

* defaults_path defaults to None in base_parser

* add helm chart parser class and common exceptions

* add missing doc strings

* Change parser class to input template class

* added all input config params + comments; added common arm template config; added instructions for completing publish/delete

* add typing to base processor and add copyright statement to new files

* fixed formatting on input configs

* fixed nsd input config + tidied other input config files

* added comments for images; general formatting

* rename template parsers to input templates and add helm chart processor

* add __init__.py to folders

* fixed imports + added innit in folders

* fixed imports + added defaults for input params

* Not quite complete first pass at definition folder handlers

* added generate config log; fixed input config objects

* rename InputTemplate to InputArtifacts

* tidied write config + added read config; deleted json file checked in by mistake

* added overwrite validation to generate config; added j2 templates to common

* added validation to base config and nsd

* Add UTs and fix up definition folder code

* added validation to nsd + cnf; added default_file_name property; added tests for generate config; added example nsd-input.jsonc for testing

* add vhd processor

* remove leftover file from merge

* added vnf config validation; improved comment spacing on input.json; fixed depends on format; changes type for optional params

* added optional output file name param to generate config; removed misc print statements

* Fix up some type hinting

* added write manifest bicep and nf application to base handler; fixed helm config to produce correct bicep

* push latest changes

* Initial ArmInputTemplate class

* Outline ArmBuildProcessor hierarchy

* Update VNF tests to keep built output for comparison

* WIP, for sharing with Jacob

* Incremental update

* added vnf config validation; improved comment spacing on input.json; fixed depends on format; changes type for optional params

* added optional output file name param to generate config; removed misc print statements

* Approximately complete ARM processor. No tests, no testing yet.

* Fix artifact store reference

* WIP

* fixed cnf bicep template

* fixed multiple helm/vhd/arm error; working vnfartifactmanifet; attempted vnfdefintiion with testing code still in; updated write bicep functions to take 2 arguments for vnf case

* fixed cnfdef bicep; return correct type in cnf handler

* Added outputfolder name to base handler; reorganised templates folder structure; added constants for cnf j2 templates; implemented build (tested with mocks) for cnf handler; implemented localfileACR artifact to_dict function; updated write for artifact_builder.py; added overwriting folder logic to defintion folder builder

* renamed write manifest; updated nf templates to deploy initial resources; vnf templates working; vnf build commands working

* added logic to cnf handler for manifest and definition supporting files + config mappings

* fixed cnf params files; added render params for vnf

* fix HelmChartInput issues

* Merge arm-processor code into Jacob's branch (#127)

* Initial ArmInputTemplate class

* Outline ArmBuildProcessor hierarchy

* Update VNF tests to keep built output for comparison

* Initial ArmInputTemplate class

* Outline ArmBuildProcessor hierarchy

* Update VNF tests to keep built output for comparison

* WIP, for sharing with Jacob

* Incremental update

* Approximately complete ARM processor. No tests, no testing yet.

* Fix artifact store reference

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* added build deploy params schema to base handler; added functionality for deployParams to be added as supporting file for cnd

* fix majority of linting issues

* renamed write on base handler to render; added build logic for manifest and artifact list for vnf

* added write manifest bicep and nf application to base handler; fixed helm config to produce correct bicep

* fixed cnf bicep template

* Initial ArmInputTemplate class

* complete helm chart processor

* almost finished NFD processor

* WIP, for sharing with Jacob

* Incremental update

* added vnf config validation; improved comment spacing on input.json; fixed depends on format; changes type for optional params

* added optional output file name param to generate config; removed misc print statements

* Approximately complete ARM processor. No tests, no testing yet.

* WIP

* fixed multiple helm/vhd/arm error; working vnfartifactmanifet; attempted vnfdefintiion with testing code still in; updated write bicep functions to take 2 arguments for vnf case

* fixed cnfdef bicep; return correct type in cnf handler

* Added outputfolder name to base handler; reorganised templates folder structure; added constants for cnf j2 templates; implemented build (tested with mocks) for cnf handler; implemented localfileACR artifact to_dict function; updated write for artifact_builder.py; added overwriting folder logic to defintion folder builder

* renamed write manifest; updated nf templates to deploy initial resources; vnf templates working; vnf build commands working

* added logic to cnf handler for manifest and definition supporting files + config mappings

* fixed cnf params files; added render params for vnf

* added build deploy params schema to base handler; added functionality for deployParams to be added as supporting file for cnd

* renamed write on base handler to render; added build logic for manifest and artifact list for vnf

* fix up code

* fix base input

* run isort

* implemented vnf build + removed test code; fixed arm processor

* fixed templates

* removed multiple vhds from vnf + fixed bicep; made path to mappings optional for cnf

* renamed write file to render contents

* fixed helm chart processor + small tidy up

* commit for build handover; not working + handover notes sent separately

* run isort

* fix issues in input classes

* add generic schema and value mapping generation and fix arm and vhd processors

* push changes I forgot to push before xmas

* checked out fixed build processors and inputs from jdarby/add-build-processors

* fix values and schema generation

* add RET generation for ARM templates

* fix linting issues

* made input file name constant + renamed inputs to match changes

* checked out build processor changes

* Moved _render_deployment_params_schema and _build_deploy_params_schema to nfd base handler; added default_config logic to cnf handler;created deploymentParamers for cnf + vnf

* changed j2 template for vhd image name

* HELM CHART PROCESSOR CHANGES! fixed registry value path and depends on profile in cnf template

* fixed nsd artifact manifest, changed artifact type in all processers (PROCESSOR CHANGE)

* implemented nsd build get artifact manifest and get artifact list

* added base bicep to all handlers; edited j2 templates to note that base resources should be deployed first on publish; made all build use constants

* added to_dict for localfileACRartifact

* added source namespcae and source reigstry to artifact + in helm processor callinh remote arc artifacts

* finish nfd processor

* add copyright statement to helm processor file

* linting

* created common params folder (making new jsonbuilder), adding get params config to base', renamed get_config to get_input_config; aded logging to vnf; chnged custom.py publish inputs

* partially ready commit; added cmd context to base + added some logic to nsds

* added all parameters constant

* tidied vnf handler; added common params logic to cnf

* markups inc tidy up

* renamed snake_case param

* add nsd output config

* taken some input and build processor changes from jdarby/build_processor branch

* Add logging, improve doc string and fix mypy errors for inputs

* fix 2 bugs introduced by merging buildprocessors and adding json deploy params

* fixed how aosm client is passed to build; properly get nfdv object with api client

* refactored vnf handler to create processors upfront

* refactor cnf to instantiate processors upfront

* Improve docstrings, add logging and fix linting issues for build processors

* nsd temp commit

* fix missed conflict

* fix linting and formatting issue

* rename + add constants + add new definition tempalte

* simplified render bicep definiton contents + removes all constants for filenames from nf handlers and templates

* build nsd bicep core working

* fixed nsd bicep

* Fix two minor CLI bugs (#129)

* Fix bug where the build directory wasn't deleted

* Fix bug where the json wasn't output correctly

* fixed incorrect merge fix

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* small fixes; removed location from nfd input, removed comma from vnd def template, fixed artifact version in nsds, fixed vhd validation

* made cgs name constant to fix error in mappings

* added store type to all the templates

* tidy up + small markups

* removed version state from the definition biceps

* fixed bug where schemas and defaults were copied incorrectly

* made artifact paths absolute in all cases except nsd nfs, where paht is relative to nsd output folder

* added missing comments; renamed common params + edited its format; changed custom to take path

* added existing back to all templates + descriptors of resources

* Merge publish into temp wheel branch (#131)

* Move artifact create from dict logic to instantiating code

* Create CommandContext class to hold Azure clients and CLI options, and pass instance through to the delete and publish commands.

* Mostly implemented and working publish. Lots of debug code still present.

* Publish done and mostly tested.

* Add some more logging. Remove help text referring to --order-params.

* Update src/aosm/azext_aosm/common/artifact.py

Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* fix merge conflicts

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* Minor input improvements (#132)

* fixed common params files for all

* remove prints; remove sourcelocaldockerimage + add correct validation; edit input.json comments

* fixed extract tar error

* only create oras_client once - temp solution

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* edited input file (#133)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* fixed getparamsconfig for vnf/nsd; added fixes for building correct python wheel

* Achurchard/publish (#130)

Markups from publish PR

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: jordlay <72226943+jordlay@users.noreply.github.com>

* bug fixes for chart with subcharts

* added ruamel

* Use safe yaml loading

* Move code out of import list

* Fix errant config line bug

* fixed deployparams error (#134)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* fixed yaml load error

* disabled multi anchor yaml warning for values.yaml

* delete accidental deployparams file

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Chaos Chhapi <chaos.chhapi@metaswitch.com>
Co-authored-by: Jacob <53872686+jddarby@users.noreply.github.com>
Co-authored-by: Jacob Darby <jdarby@microsoft.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: patrykkulik-microsoft <116072282+patrykkulik-microsoft@users.noreply.github.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* fix silly yaml import

* moved config validate to init, commented out delete command, add context to publish + passed paths properly in custom.py

* Add Helm template validation to the build method in the CLI (#136)

* added empty template parser

* Initial scaffolding of some new classes

* added utils, added base builder + reader + their children, added nfd and vhd processors

* moved utils to common folder + added local file builder

* Add some basic implementations

* add new commands and restructure command groups

* better naming for command groups

* revert addition on the onboard command group

* update HISTORY.rst

* fix style issue

* fix linting issues

* added empty vhd and nfd processors; moved client factory from old repo

* Add template parser interface (BaseParser)

* Add parameters to BaseParser

* Make defaults_path optional in base_parser

* defaults_path defaults to None in base_parser

* add helm chart parser class and common exceptions

* add missing doc strings

* Change parser class to input template class

* added all input config params + comments; added common arm template config; added instructions for completing publish/delete

* add typing to base processor and add copyright statement to new files

* fixed formatting on input configs

* fixed nsd input config + tidied other input config files

* added comments for images; general formatting

* rename template parsers to input templates and add helm chart processor

* add __init__.py to folders

* fixed imports + added innit in folders

* fixed imports + added defaults for input params

* Not quite complete first pass at definition folder handlers

* added generate config log; fixed input config objects

* rename InputTemplate to InputArtifacts

* tidied write config + added read config; deleted json file checked in by mistake

* added overwrite validation to generate config; added j2 templates to common

* added validation to base config and nsd

* Add UTs and fix up definition folder code

* added validation to nsd + cnf; added default_file_name property; added tests for generate config; added example nsd-input.jsonc for testing

* add vhd processor

* remove leftover file from merge

* added vnf config validation; improved comment spacing on input.json; fixed depends on format; changes type for optional params

* added optional output file name param to generate config; removed misc print statements

* Fix up some type hinting

* added write manifest bicep and nf application to base handler; fixed helm config to produce correct bicep

* push latest changes

* Initial ArmInputTemplate class

* Outline ArmBuildProcessor hierarchy

* Update VNF tests to keep built output for comparison

* WIP, for sharing with Jacob

* Incremental update

* added vnf config validation; improved comment spacing on input.json; fixed depends on format; changes type for optional params

* added optional output file name param to generate config; removed misc print statements

* Approximately complete ARM processor. No tests, no testing yet.

* Fix artifact store reference

* WIP

* fixed cnf bicep template

* fixed multiple helm/vhd/arm error; working vnfartifactmanifet; attempted vnfdefintiion with testing code still in; updated write bicep functions to take 2 arguments for vnf case

* fixed cnfdef bicep; return correct type in cnf handler

* Added outputfolder name to base handler; reorganised templates folder structure; added constants for cnf j2 templates; implemented build (tested with mocks) for cnf handler; implemented localfileACR artifact to_dict function; updated write for artifact_builder.py; added overwriting folder logic to defintion folder builder

* renamed write manifest; updated nf templates to deploy initial resources; vnf templates working; vnf build commands working

* added logic to cnf handler for manifest and definition supporting files + config mappings

* fixed cnf params files; added render params for vnf

* fix HelmChartInput issues

* Merge arm-processor code into Jacob's branch (#127)

* Initial ArmInputTemplate class

* Outline ArmBuildProcessor hierarchy

* Update VNF tests to keep built output for comparison

* Initial ArmInputTemplate class

* Outline ArmBuildProcessor hierarchy

* Update VNF tests to keep built output for comparison

* WIP, for sharing with Jacob

* Incremental update

* Approximately complete ARM processor. No tests, no testing yet.

* Fix artifact store reference

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* added build deploy params schema to base handler; added functionality for deployParams to be added as supporting file for cnd

* fix majority of linting issues

* renamed write on base handler to render; added build logic for manifest and artifact list for vnf

* added write manifest bicep and nf application to base handler; fixed helm config to produce correct bicep

* fixed cnf bicep template

* Initial ArmInputTemplate class

* complete helm chart processor

* almost finished NFD processor

* WIP, for sharing with Jacob

* Incremental update

* added vnf config validation; improved comment spacing on input.json; fixed depends on format; changes type for optional params

* added optional output file name param to generate config; removed misc print statements

* Approximately complete ARM processor. No tests, no testing yet.

* WIP

* fixed multiple helm/vhd/arm error; working vnfartifactmanifet; attempted vnfdefintiion with testing code still in; updated write bicep functions to take 2 arguments for vnf case

* fixed cnfdef bicep; return correct type in cnf handler

* Added outputfolder name to base handler; reorganised templates folder structure; added constants for cnf j2 templates; implemented build (tested with mocks) for cnf handler; implemented localfileACR artifact to_dict function; updated write for artifact_builder.py; added overwriting folder logic to defintion folder builder

* renamed write manifest; updated nf templates to deploy initial resources; vnf templates working; vnf build commands working

* added logic to cnf handler for manifest and definition supporting files + config mappings

* fixed cnf params files; added render params for vnf

* added build deploy params schema to base handler; added functionality for deployParams to be added as supporting file for cnd

* renamed write on base handler to render; added build logic for manifest and artifact list for vnf

* fix up code

* fix base input

* run isort

* implemented vnf build + removed test code; fixed arm processor

* fixed templates

* removed multiple vhds from vnf + fixed bicep; made path to mappings optional for cnf

* renamed write file to render contents

* fixed helm chart processor + small tidy up

* commit for build handover; not working + handover notes sent separately

* run isort

* fix issues in input classes

* add generic schema and value mapping generation and fix arm and vhd processors

* push changes I forgot to push before xmas

* checked out fixed build processors and inputs from jdarby/add-build-processors

* fix values and schema generation

* add RET generation for ARM templates

* fix linting issues

* made input file name constant + renamed inputs to match changes

* checked out build processor changes

* Moved _render_deployment_params_schema and _build_deploy_params_schema to nfd base handler; added default_config logic to cnf handler;created deploymentParamers for cnf + vnf

* changed j2 template for vhd image name

* HELM CHART PROCESSOR CHANGES! fixed registry value path and depends on profile in cnf template

* fixed nsd artifact manifest, changed artifact type in all processers (PROCESSOR CHANGE)

* implemented nsd build get artifact manifest and get artifact list

* added base bicep to all handlers; edited j2 templates to note that base resources should be deployed first on publish; made all build use constants

* added to_dict for localfileACRartifact

* added source namespcae and source reigstry to artifact + in helm processor callinh remote arc artifacts

* finish nfd processor

* add copyright statement to helm processor file

* linting

* created common params folder (making new jsonbuilder), adding get params config to base', renamed get_config to get_input_config; aded logging to vnf; chnged custom.py publish inputs

* partially ready commit; added cmd context to base + added some logic to nsds

* added all parameters constant

* tidied vnf handler; added common params logic to cnf

* markups inc tidy up

* renamed snake_case param

* add nsd output config

* taken some input and build processor changes from jdarby/build_processor branch

* Add logging, improve doc string and fix mypy errors for inputs

* fix 2 bugs introduced by merging buildprocessors and adding json deploy params

* fixed how aosm client is passed to build; properly get nfdv object with api client

* refactored vnf handler to create processors upfront

* refactor cnf to instantiate processors upfront

* Improve docstrings, add logging and fix linting issues for build processors

* nsd temp commit

* fix missed conflict

* fix linting and formatting issue

* rename + add constants + add new definition tempalte

* simplified render bicep definiton contents + removes all constants for filenames from nf handlers and templates

* build nsd bicep core working

* fixed nsd bicep

* Fix two minor CLI bugs (#129)

* Fix bug where the build directory wasn't deleted

* Fix bug where the json wasn't output correctly

* fixed incorrect merge fix

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* small fixes; removed location from nfd input, removed comma from vnd def template, fixed artifact version in nsds, fixed vhd validation

* made cgs name constant to fix error in mappings

* added store type to all the templates

* tidy up + small markups

* removed version state from the definition biceps

* fixed bug where schemas and defaults were copied incorrectly

* made artifact paths absolute in all cases except nsd nfs, where paht is relative to nsd output folder

* added missing comments; renamed common params + edited its format; changed custom to take path

* added existing back to all templates + descriptors of resources

* First stab at doing helm template - check the changes here

* Merge publish into temp wheel branch (#131)

* Move artifact create from dict logic to instantiating code

* Create CommandContext class to hold Azure clients and CLI options, and pass instance through to the delete and publish commands.

* Mostly implemented and working publish. Lots of debug code still present.

* Publish done and mostly tested.

* Add some more logging. Remove help text referring to --order-params.

* Update src/aosm/azext_aosm/common/artifact.py

Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* fix merge conflicts

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* Minor input improvements (#132)

* fixed common params files for all

* remove prints; remove sourcelocaldockerimage + add correct validation; edit input.json comments

* fixed extract tar error

* only create oras_client once - temp solution

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* edited input file (#133)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Add skip step

* fixed getparamsconfig for vnf/nsd; added fixes for building correct python wheel

* Achurchard/publish (#130)

Markups from publish PR

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: jordlay <72226943+jordlay@users.noreply.github.com>

* bug fixes for chart with subcharts

* added ruamel

* Use safe yaml loading

* Move code out of import list

* Fix errant config line bug

* fixed deployparams error (#134)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* fixed yaml load error

* Change "path_to_mappings" to "default_values"

* Add unit tests

* remove the merge mistake

* Delete a file

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Chaos Chhapi <chaos.chhapi@metaswitch.com>
Co-authored-by: Jacob <53872686+jddarby@users.noreply.github.com>
Co-authored-by: Jacob Darby <jdarby@microsoft.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: jordlay <72226943+jordlay@users.noreply.github.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* Pk5/add image parsing (#137)

* Add image parsing

* Add unit tests

* Fix small log issue

* Minor markup edits

* Improve unit tests

* remove the test_utils file

* update HISTORY.rst

* update HISTORY file

* Validate that helm chart values exist (#138)

* add validation of the default values for helm charts

* Add unit tests

* update HISTORY.rst

* Markups

* Jl/nsd publish paths (#139)

* fix for relative path issue for nsd publish; fix for deployment parameters schema being wrong

* Add image parsing

* LocalFileACRArtifact converts bicep to ARM before upload.

* Remove TODO comment that is done. Refactor convert to bicep code.

* Add unit tests

* Fix small log issue

* Minor markup edits

* Add location to configObject passed to NF template. Value is hardcoded to that provided in the input.jsonc file.

* Add note on using NF name instead of NSD name when creating NFDInput

* Minor fixes: - check attribute exists before accessing it\n - better logging\n - reduce nesting

* input file (jsonc) comment updates.

* Fix NSD generate --output-file handling bug

* Minor markups.

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Patryk Kulik <patrykkulik@microsoft.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* Bump version to 1.0.0b5

* Linting and typing (#141)

Linting and type hinting fixes.

* Temp 16feb wheel (#145)

* added nexus arm processor; added nfvi type to vnfinput.json; added condition for calling each arm processor

* pipe through nfvi type from vnf input to template; added nexus input; fixed mistakes in armprocessor

* initial commit for children vnf handlers

* added core and nexus config logic

* fixed nexus input and nexus processor; fixed templates

* generalised render manifest and render definition bicep functions to use one

* added incorrect config error handling

* added nexus flag to publish; added error handling for incorrect vnf type (if forgot to put nexus flag case); tidied nexus inputs

* added vnf nexus base bicep; fixed vnf definition template; temp fix for image versions

* moved render bicep to common/utils; replaced build base bicep with render bicep

* general tidyup: removed prints, added return types

* added nfvi type to nsds

* removed old todos

* refactored nexus handler, moved generate params code into processor

* moved logic to base vnf handler; moved more logic to processor

* fix template name in vnf j2

* fixed nexus image file

* added nfvitype to nsd nf template by making new j2 + changing how nfd processor works

* added nfvitype to nsd nf template by making new j2 + changing how nfd processor works

* minor formatting

* made vnfnexus a definition type; slight refactor of custom.py

* removed nexus param, removed prints, added commented out test file

* fixed flake8 + pylint issues

* Base handler treats command inputs separately (#143)

* refactored base handler init to treat inputs from different commands separately; added better validation

* fixed error handling in base handler

* fixed error typing

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* mypy fixes

* fixed customLocation id for vnf nexus

* markups from review inc moving build manifest to parent vnf handler

* added better docstrings

* updated history.rst

* Achurchard/fix helm chart upload (#144)

* Use helm push for Helm charts (not oras push)

* Logging

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* bumped version

* Bug: No type in schema (#148)

* first fix for anyOf logic error msg

* Update src/aosm/azext_aosm/build_processors/base_processor.py

Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* Update src/aosm/azext_aosm/build_processors/base_processor.py

Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* Bug: Nexus Image Version Must be Semver (#149)

* added semver checking to input config validation; moved split image path to utils

* changed semver regex; renamed function

* fixed typo

* markups

* fix typo

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Create RG if it doesn't exist (#150)

* add validation resource group exists function

* tidied up code

* Update src/aosm/azext_aosm/definition_folder/reader/definition_folder.py

Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* renaming from markups

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* Bug Fix: NFD and NSD Manifest Names Clash (#147)

* added sa_manifest and acr_manifest property, added sa and acr to manifest names; added nsd to nsd manifest name

* create manifest name from nf/nsd name instead of acr/sa; fixed docs strings

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Fix Nexus Linting + Add Unit Tests (#146)

* fixed pylint + flake8 errors

* fix mypy errors

* fixed artifact builder tests

* temp commit for unit testing

* temp push of broken tests

* added new mocks (not perfect) for vnfs£

* fixed artifact write failure

* More mypy fixes

* fixed style issues

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* Use ephemeral tempdir for generated helm package .tgz file. (#151)

* Use ephemeral tempdir for generated helm package .tgz file.

* Fix file_path bug if .tgz file was provided by user.

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>

* add to changelog; bump version

* added check for filepath before making absolute (#154)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Template Parameters Bug (#156)

* converted vhd parameters to camel case to match what aosm expects

* markups + fixed apiVersion

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* fixed config comment (#153)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* removed image name parameter, added imageName to default config for arm and vhd input (#157)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* bumped version and updated changelog (#158)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Improve Unit Testing (#152)

* moved working tests to new folder structure; added empty tests for processors and build

* added empty generate cofnig tests; fixed and moved bicep,artifact and definitino folder builder tests

* added nexus arm tests; removed outdated vnf mocks

* added azure core tests for every function (including base)

* fixed up core and nexus arm processor

* fixed up arm processors; added logging to tests

* added arm template tests

* added test from copilot learning day

* changed assert

* removed build folder; added json dump to artifact and definition tests; improved arm processor testing

* removed mock open and replaced with new templates

* fixed linting

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Fix bool in schema bug (#160)

* check object is a dict before looking for `type` key.

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Use common.utils function to check if docker/helm is installed (code deduplication). (#161)

* changed configuration type from secret to open; updated changelog (#162)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Support using multiple images sources in our CLI (#142)

* Initial stab at making the multiple registry support work

* Update TODO

* update TODO

* merge fixes

* add logic to find registry credentials

* Code cleanup and adding unit tests

* updates to the registry class

* In Progress work

* Working publish

* Move _push_image_from_local_registry and copy_image into the registry class

* tidy up changes

* Namespace and style fixes

* Minor input config change

* unit tests

* Do not push image namespace to target ACR

* Make sure not to break the nexus part of the code

* Update CHANGELOG

* Fix error not being caught correctly

* Minor comment change

* Markups

* Update warning

* Change how we treat namespace and find images

* markups

* modify how we create the registry list

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* Fix integration tests (#163)

* Initial stab at making the multiple registry support work

* Update TODO

* update TODO

* merge fixes

* add logic to find registry credentials

* Code cleanup and adding unit tests

* updates to the registry class

* In Progress work

* Working publish

* Move _push_image_from_local_registry and copy_image into the registry class

* tidy up changes

* Namespace and style fixes

* Minor input config change

* unit tests

* Do not push image namespace to target ACR

* Make sure not to break the nexus part of the code

* Update CHANGELOG

* initial commit for integration tests

* Fix error not being caught correctly

* Minor comment change

* Fix integration tests

* Moving files around

* Working vnf integration test

* Comment out test that is not working

* Clean up the structure of the integration tests

* Delete unnecessary tests

* Fix CNF test and move a util function

* fix other integration tests

* Delete the broken tests folder

* Fix the vnf test

* move files around

* Improve the update_input_file function

* improve the nsd test

* Move files around and improve the nsd output

* remove unnecessary line

* Update recording processors and recordings

* Fix linting issues

* bad merge change

* Update the nsd output with Open CGVs

* Fix few unit tests broken by merge

* Markups

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Add docker dependency option to oras in setup.py (#164)

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* Revert "Add docker dependency option to oras in setup.py (#164)" (#165)

This reverts commit 9b6fcde.

* update history + bump version (#166)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* hot fix: anyOf bug

* hotfix: fixed 2 style errors

* bumped version to 2 (#170)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Fix linting + tests for release (#171)

* removed delete helptext and reran tests live

* fixed linting

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* added license headers to fix release jobs (#172)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Add Webhook (#159)

* initial attempt at adding roleOverride

* add comma

* removed comma as breaks single nf application

* remove prints

* fixed linting + updated history

* fixed bug in nfd processor for vnfs; updated nsd tests

* fixed lives tests

* markups

* markups2

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Expose All PRs (#173)

* Refactoring related to user customisable param exposure (#167)

* Fix: Change 'deploymentParameters' to 'deployParameters'

* Refactoring including:
 - Remove minor inconsistencies between related methods
 - Use named parameters in method calls to improve readability
 - Rename variables and methods to be more descriptive/accurate
 - Improve some exception messages
 - Make log messages clearer
 - Improve code comments
 - Improve type handling

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>

* Allow all parameters to be exposed to operator (#169)

* Fix: Change 'deploymentParameters' to 'deployParameters'

* Refactoring including:
 - Remove minor inconsistencies between related methods
 - Use named parameters in method calls to improve readability
 - Rename variables and methods to be more descriptive/accurate
 - Improve some exception messages
 - Make log messages clearer
 - Improve code comments
 - Improve type handling

* Comment out _find_image_pull_secrets_values_paths().

* Add expose_all function for NFDs.

Includes extensive renaming of variables and methods, new code comments
and docstrings.

* Add expose_all_params to nfd-input.jsonc and plumb through.

* Fix linting + tests for release (#171)

* removed delete helptext and reran tests live

* fixed linting

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* added license headers to fix release jobs (#172)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Markups

* Add Webhook (#159)

* initial attempt at adding roleOverride

* add comma

* removed comma as breaks single nf application

* remove prints

* fixed linting + updated history

* fixed bug in nfd processor for vnfs; updated nsd tests

* fixed lives tests

* markups

* markups2

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* fixed line too long

* markups including removing multiple instances

* fixed all unit tests based on new param (expose_all), removed param (multiple_instances), refactoring of deploymentParameters to deployParams, and removal of using values.schema.json

* ran live tests + removed dependsOn

* added getting defaults from arm template + added special logic for when defaults are rg().location

* fixed tests + fixed styling

* ran live tests

---------

Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: jordlay <72226943+jordlay@users.noreply.github.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Patryk Kulik <patrykkulik@microsoft.com>

---------

Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Patryk Kulik <patrykkulik@microsoft.com>

* updated history

* Fix minor config bugs (#174)

* renamed nfdvName to nfdv

* changed comment for name in NF RET for nsd input

* added ArmTemplate  optional comment to NSD input config

* changed nfdv examples in mock cgvs

* added 1:1 mapping between nfdvs and nfvisFromSite

* removed nfvi_type from nsd input config

* markups

* fixed tests + styling; markups

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Help text additions (#175)

* Add long summary, parameters and examples to help text.

* Remove parameters from help file. Instead, use the help defined in _params.py. Minor updates to text of latter.

* Fix lines too long (#176)

* updated changelog (#180)

* updated changelog

* markups

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Autogen CLI: (#181)

- Add examples
- Minor rewording
- Ensure all commands are preview

* Add quotes to the CNF input config image sources comment (#182)

* Bump jinja2 to 3.1.4. (#190)

* Remove azure-storage-blob from dependencies. (#192)

* Pk5/fix integration tests for release (#195)

* Add retry logic to fix integration tests

* Modify the publisher name because previous name is used up

* Regenerate the recordings

* Re-record test (#196)

* ran vnf test live (#197)

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

* Make the vnf test live only (#198)

---------

Co-authored-by: Jordan <jordan.layton@metaswitch.com>
Co-authored-by: Chaos Chhapi <chaos.chhapi@metaswitch.com>
Co-authored-by: Jacob <53872686+jddarby@users.noreply.github.com>
Co-authored-by: Jacob Darby <jdarby@microsoft.com>
Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com>
Co-authored-by: patrykkulik-microsoft <116072282+patrykkulik-microsoft@users.noreply.github.com>
Co-authored-by: Cyclam <95434717+Cyclam@users.noreply.github.com>
Co-authored-by: Patryk Kulik <patrykkulik@microsoft.com>
  • Loading branch information
9 people authored May 20, 2024
1 parent e1fbabe commit 8decf29
Show file tree
Hide file tree
Showing 259 changed files with 24,263 additions and 6,746 deletions.
33 changes: 33 additions & 0 deletions src/aosm/HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,39 @@
Release History
===============

2.0.0b1
++++++++
* Renamed nfdvName to nfdv in CGVs
* Added useful comments to input files
* Added 1:1 mapping between NFVIsFromSite and NF RETs
* Added expose_all parameter in input file to expose all parameters in deployParameters and CGS
* Removed multiple_instances and depends_on from input file
* Added: mutating webhook for injectArtifactStoreDetails
* Added: Users can specify multiple image sources from all types of registries (not just ACRs). General improvements in how CNF image sources are handled.
* Fixed: Namespace appeared twice in the `artifacts.json` file, leading to errors in the publish step of the CLI.
* Changed configurationType for NF Resources from Secret to Open
* Removed imageName from deployParameters
* Removed image name parameter from input file
* Fixed camel casing of VHD Parameters
* Fixed blob sas url bug
* Edited comment in input file to reflect RGs are created if they do not exist
* Added creating RG if it does not exist
* Removed use of permanent temp file for helm package
* Fixed: helm charts not uploading correctly
* Added creation of resource groups if does not exist
* Fixed: Manifest name built from ACR name, so clashes
* Fixed: Nexus image version must be semver
* Fixed: Sensible error when no type given in helm chart schema
* Fixed: customLocation missing from Nexus
* Fixed: helm charts not uploading correctly
* Added: Nexus support
* Add `publisher` command group for management of publisher resources.
* Changed the name of the `path_to_mappings` parameter in the CNF input file to `default_values`
* Added a `helm template` validation step to the `az aosm nfd build` command for the `cnf` definition type
* Added validation of the values file for helm charts when using the `az aosm nfd build` command for the `cnf` definition type
* Fixed helm chart image parsing in the `az aosm nfd build` command for the `cnf` definition type. This means that the images can now be extracted correctly from the helm chart.
* Fixed: infinite loop bug when retrying failed artifact uploads to the ACR

1.0.0b4
++++++++
* Fixed: Remove check for Allow-2023-09-01 feature flag that is no longer required (Bug #1063964)
Expand Down
49 changes: 11 additions & 38 deletions src/aosm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,10 @@ For CNFs you must have these packages installed on the machine you are running t
- `docker` installed only in some circumstances, those being if the source image is in your local docker repository, or you do not have subscription-wide permissions required to push charts and images. See the remainder of this section for further details. Docker provides packages that easily configure docker on [Windows](https://docs.docker.com/docker-for-windows/), or [Linux](https://docs.docker.com/engine/install/#supported-platforms) systems.

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.
* images for your CNF. For these you have the following options:
- a reference to an existing Azure Container Registry which contains the images for your CNF. Currently, only one ACR and namespace is supported per CNF. The images to be copied from this ACR are populated automatically based on the helm package schema. You must have Reader/AcrPull permissions on this ACR. To use this option, fill in `source_registry` and optionally `source_registry_namespace` in the input.json file.
- or, the image name of the source docker image from local machine. This is for a limited use case where the CNF only requires a single docker image which exists in the local docker repository. To use this option, fill in `source_local_docker_image` in the input.json file. This requires docker to be installed.
* 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 with an associated schema. These files must be on your disk and will be referenced in the `cnf-input.jsonc` config file.
* A reference to an existing Azure Container Registry which contains the images for your CNF. Currently, only one ACR and namespace is supported per CNF. The images to be copied from this ACR are populated automatically based on the helm package schema. You must have Reader/AcrPull permissions on this ACR. To use this, fill in `source_registry` and optionally `source_registry_namespace` in the cnf-input.jsonc file.
* 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.
* When filling in the cnf-input.jsonc file, you must list helm packages in the order they are to be deployed. For example, if A must be deployed before B, your cnf-input.jsonc should look something like this:

"helm_packages": [
{
Expand Down Expand Up @@ -106,35 +104,17 @@ 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.
This will output a file called `cnf-input.jsonc` 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]`
`az aosm nfd build --config-file cnf-input.jsonc`

Publish a pre-built definition

`az aosm nfd publish --config-file input.json`

Delete a published definition
`az aosm nfd publish --build-output-folder cnf-cli-output`

`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

Expand All @@ -149,24 +129,17 @@ 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.
This will output a file called `nsd-input.jsonc` 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`
`az aosm nsd build --config-file nsd-input.jsonc`

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 publish --build-output-folder nsd-cli-output`

`az aosm nsd delete --config-file input.json --clean`

## Bug Reporting

Expand Down Expand Up @@ -200,4 +173,4 @@ az config set logging.enable_log_file=false
```

## Development
Information about setting up and maintaining a development environment for this extension can be found [here](./development.md).
Information about setting up and maintaining a development environment for this extension can be found [here](https://eng.ms/docs/strategic-missions-and-technologies/strategic-missions-and-technologies-organization/azure-for-operators/aiops/aiops-orchestration/aosm-product-docs/processes/cli_contributing).
9 changes: 9 additions & 0 deletions src/aosm/azext_aosm/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,17 @@ def __init__(self, cli_ctx=None):
super().__init__(cli_ctx=cli_ctx, custom_command_type=aosm_custom)

def load_command_table(self, args):
from azure.cli.core.aaz import load_aaz_command_table

from azext_aosm.commands import load_command_table

try:
from . import aaz
except ImportError:
aaz = None
if aaz:
load_aaz_command_table(loader=self, aaz_pkg_name=aaz.__name__, args=args)

load_command_table(self, args)
return self.command_table

Expand Down
4 changes: 3 additions & 1 deletion src/aosm/azext_aosm/_client_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ def cf_aosm(cli_ctx, *_) -> HybridNetworkManagementClient:
# By default, get_mgmt_service_client() sets a parameter called 'base_url' when creating
# the client. For us, doing so results in a key error. Setting base_url_bound=False prevents
# that from happening
return get_mgmt_service_client(cli_ctx, HybridNetworkManagementClient, base_url_bound=False)
return get_mgmt_service_client(
cli_ctx, HybridNetworkManagementClient, base_url_bound=False
)


def cf_resources(cli_ctx, subscription_id=None):
Expand Down
Loading

0 comments on commit 8decf29

Please sign in to comment.