Merge branch 'main' into fix-open-source

Author: ajaythakurintel

charts/tenancy-manager/Chart.yaml

@@ -6,8 +6,8 @@ apiVersion: v2
 name: tenancy-manager
 description: Multi Tenancy Manager
 type: application
-version: 0.1.6
-appVersion: "1.1.2"
+version: 0.1.7
+appVersion: "1.1.3"
 annotations: {}
 home: tenancy-iam.intel.com
 maintainers:

mage/test.go

@@ -44,6 +44,7 @@ func (Test) golang() error {
 		"nexus/kube-openapi/pkg/util/proto/validation",
 		"nexus/kube-openapi/pkg/schemamutation",
 		"nexus/kube-openapi/test/integration",
+		"tenancy-manager/fuzztest",
 	}
 
 	return sh.RunV(

nexus-api-gw/README.md

@@ -79,14 +79,12 @@ Nexus API Gateway is responsible for five primary functions:
 
 ## Get Started
 
-Install Nexus API Gateway.
+Nexus API Gateway gets deployed as a k8s pod along with the deployment of Edge Manageability Framework deployment. But user can also install Nexus API Gateway using the helm chart on their own k8s cluster using following command.
 
 ```shell
-helm install -n orch-iam --create-namespace charts/nexus-api-gw
+helm install -n orch-iam --create-namespace nexus-api-gw charts/nexus-api-gw
 ```
 
-Another way to try out Nexus API Gateway is by using the Open Edge Platform deployment.
-
 ## Develop
 
 Nexus API Gateway is developed in the **Go** language and is built as a Docker image through a `Dockerfile` in
@@ -120,9 +118,11 @@ The basic workflow to make changes to the code, verify those changes, and create
 
 1. Run linters with the `make lint` command.
 
+   NOTE: As of now, `make lint` command returns errors. This will be fixed soon.
+
 2. Run the unit tests with the `make test` command.
 
-3. Build the code with the `make build` command.
+3. Build the code with the `make build` command to create the docker image.
 
 ## Contribute
 
@@ -138,6 +138,7 @@ make lint
 make license
 make build
 ```
+NOTE: As of now, `make lint` command return errors. This will be fixed soon.
 
 You can use `help` to see a list of makefile targets.
 The following is a list of makefile targets that support developer activities:
@@ -153,7 +154,7 @@ The following is a list of makefile targets that support developer activities:
 - `go-build` to build the Go source code files
 - `test` to run the unit tests
 - `coverage` to run the unit test coverage
-- `build` to build the Nexus API Gateway Docker container
+- `build` to build the Nexus API Gateway Docker image
 - `release` to publish the built Nexus API Gateway Docker container to a pre-defined Docker container registry.
   This registry is set in an environment variable (`API_GW_DOCKER_IMAGE_OEP`) in `nexus-api-gw/Makefile`.
 

tenancy-api-mapping/README.md

@@ -36,14 +36,12 @@ These CRs are expected to be created/updated only at the time of install or upgr
 
 ## Get Started
 
-Install Tenancy API Mapping.
+Tenancy API Mapping gets deployed as a k8s job along with the deployment of Edge Manageability Framework deployment. But user can also install Tenancy API Mapping using the helm chart on their own k8s cluster using following command.
 
 ```shell
-helm install -n orch-iam --create-namespace charts/tenancy-api-mapping
+helm install -n orch-iam --create-namespace tenancy-api-mapping charts/tenancy-api-mapping
 ```
 
-Another way to try out Tenancy API Mapping is by using the Open Edge Platform Deployment.
-
 ## Develop
 
 Tenancy API Mapping is developed in the **Go** language and is built as a Docker image through a `Dockerfile`
@@ -75,11 +73,17 @@ This code requires the following tools to be installed on your development machi
 
 The basic workflow to make changes to the code, verify those changes, and create a GitHub pull request (PR) is:
 
-0. Edit and build the code with the `make build` command.
+0. Edit and build the code with the `make build` command. This command creates the docker image.
 
 1. Run linters with the `make lint` command.
 
-2. Run the unit tests with the `make test` command.
+2. Run the unit tests with following sequence of commands.
+
+    ```shell
+    make lint
+    make test
+    git restore --staged cmd/specgen/tests/gitsubmodules/*
+    ```
 
 ## Contribute
 
@@ -90,10 +94,10 @@ a new feature. See the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more infor
 Additionally, ensure the following commands are successful:
 
 ```shell
-make test
 make lint
 make license
 make build
+make test
 ```
 
 You can use `help` to see a list of makefile targets.
@@ -106,7 +110,7 @@ The following is a list of makefile targets that support developer activities:
 - `yamllint` - lint all YAML files
 - `test` - run Go tests
 - `coverage` - run coverage
-- `build` - run the build stage
+- `build` - run the build stage 
 - `all` - run build, lint, and test stages
 - `release` - publish the built Tenancy API Mapping Docker container to a predefined Docker container registry. This
    registry is set in an environment variable (TENANCY_API_MAPPING_DOCKER_IMAGE_OEP) in `tenancy-api-mapping/Makefile`.
@@ -262,7 +266,7 @@ For Example:
 - Update the tag.
 
   ```shell
-    yq eval '.spec.repoConf.tag = "v0.3.1"' --inplace "apimappingconfigcrs/amc-orch-metadata-broker-openapi.yaml"
+    yq eval '.spec.repoConf.tag = "v0.4.1"' --inplace "apimappingconfigcrs/amc-orch-metadata-broker-openapi.yaml"
   ```
 
 - Verify the version.
@@ -341,7 +345,12 @@ the Multi-Tenancy OpenAPI Specification Generator tool, covering all necessary s
 
 ### To Generate the Combined Open API Spec
 
-`make gen-convert-combine-all`
+```shell
+make specgen
+make convert-and-combine
+make clean-intermediate
+git restore --staged gitsubmodules/*
+```
 
 This target generates the unified OpenAPI spec for all the service API specs and the Datamodel API spec.
 

tenancy-datamodel/README.md

@@ -142,7 +142,9 @@ To contribute, please open a pull request to have your changes reviewed and merg
 Additionally, ensure the following commands are successful:
 
 ```shell
+make datamodel_build
 make lint
 make license
-make datamodel_build
+make build
 ```
+NOTE: Please note that `make build` command is for generating the docker image of Tenancy Datamodel.

tenancy-manager/README.md

@@ -42,14 +42,12 @@ The status is represented using well-defined enums that are consistently used ac
 
 ## Get Started
 
-Install Tenancy Manager.
+Tenancy Manager gets deployed as a k8s pod along with the deployment of Edge Manageability Framework deployment. But user can also install Tenancy Manager using the helm chart on their own k8s cluster using following command.
 
 ```shell
-helm install -n orch-iam --create-namespace charts/tenancy-manager
+helm install -n orch-iam --create-namespace tenancy-manager charts/tenancy-manager
 ```
 
-Another way to try out Tenancy API Mapping is by using the Open Edge Platform Deployment.
-
 ## Develop
 
 - Tenancy-Manager is developed in the **Go** language and is built as a Docker image through a `Dockerfile` in
@@ -84,9 +82,11 @@ The basic workflow to make changes to the code, verify those changes, and create
 
 2. Run linters with the `make lint` command.
 
+   NOTE: As of now, `make lint` command returns errors. This will be fixed soon.
+
 3. Run the unit tests with the `make test` command.
 
-4. Build the code with the `make build` command.
+4. Build the code with the `make build` command to create the docker image.
 
 ## Contribute
 
@@ -102,6 +102,7 @@ make lint
 make license
 make build
 ```
+NOTE: As of now, `make lint` command returns errors. This will be fixed soon.
 
 You can use `help` to see a list of makefile targets.
 The following is a list of makefile targets that support developer activities:
@@ -117,6 +118,6 @@ The following is a list of makefile targets that support developer activities:
 - `go-build` to build the Go source code files
 - `test` to run the unit tests
 - `coverage` to run the unit test coverage
-- `build` to build the tenancy-manager Docker container
+- `build` to build the tenancy-manager Docker image
 - `release` to publish the built tenancy-manager Docker container to a pre-defined Docker container registry.
   This registry is set in an environment variable (`TENANCY_MANAGER_DOCKER_IMAGE_OEP`) in `tenancy-manager/Makefile`