MGMT-16144: Operator - Add extension support #65

irinamihai · 2024-02-20T23:39:37Z

Description:

Add a new array type Spec field called Extensions
As per O-RAN.WG6.O2IMS-INTERFACE-R003-v04.00, this new field is of key:value format and it has been implemented as an array of strings
In the ORANO2IMS CR definition, the Extensions can be declared as follows:

  spec:
    extensions:
    - "{\"country\": .metadata.labels[\"country\"]}"
    - "{\"my\": {memory: .status.capacity.memory, k8s_version: .status.version.kubernetes}}"
    - |
         .metadata.labels["name"] as $name |
         {
           name: $name,
          alias: $name
         }

Each element of Spec.Extensions will be translated in an --extensions argument for the deployment manager server:

"--extensions={\"country\": .metadata.labels[\"country\"]}","--extensions={\"my\": {memory: .status.capacity.memory, k8s_version: .status.version.kubernetes}}","--extensions=.metadata.labels[\"name\"] as $name |\n{\n  name: $name,\n  alias: $name\n}\n"]

a request for extensions to the deployment manager server done in a regular hub environment with one managed cluster would return as follows:

# ./get_oran '/o2ims-infrastructureInventory/v1/deploymentManagers?fields=extensions'

[
  {
    "extensions": {
      "country": "Canada",
      "my": {
        "k8s_version": "v1.27.8+4fab27b",
        "memory": "32856932Ki"
      },
      "alias": "spoke-hub-spoke-1",
      "name": "spoke-hub-spoke-1"
    }
  }
]

openshift-ci-robot · 2024-02-20T23:39:41Z

@irinamihai: This pull request references MGMT-16144 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

Description:

Add a new array type Spec field called Extensions

As per O-RAN.WG6.O2IMS-INTERFACE-R003-v04.00, this new field is of key:value format and it has been implemented as a structure:
type Extension struct {
  Key   string `json:"key,omitempty"`
  Value string `json:"value,omitempty"`
}
In the ORANO2IMS CR definition, the Extensions can be declared as follows:
 spec:
   extensions:
   - key: country
     value: ".metadata.labels[\"country\"]"
   - key: my
     value: "{memory: .status.capacity.memory, k8s_version: .status.version.kubernetes}"

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2024-02-20T23:39:48Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from irinamihai. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

jhernand · 2024-02-21T07:54:47Z

config/crd/bases/oran.openshift.io_orano2imses.yaml

+                items:
+                  description: 'EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+                    NOTE: json tags are required.  Any new fields you add must have
+                    json tags for the fields to be serialized.'


You may want to chang or remove this ^ description before merging.

jhernand · 2024-02-21T08:23:05Z

internal/controllers/orano2ims_controller.go

-								"\"version\": .metadata.labels[\"openshiftVersion\"],\n",
-								"\"hub\": .metadata.annotations[\"global-hub.open-cluster-management.io/managed-by\"],",
-								"}"),
+							fmt.Sprintf("--extensions={%s}", extensions),


If we do this we are forcing the user to put each extension within a dictionary. That limits somehow the flexibility, as there are some jq constructs that don't start with a curly bracket. For example, you can set variables and use them later:

.metadata.labels["name"] as $name | { name: $name, alias: $name }

If we put that between curly brackets it will result in a syntax error.

I think it is better to make the extensions field an array of strings, and translate it into multiple --extensions flag. So the CR could look like this:

extensions: - | .metadata.labels["name"] as $name | { name: $name, alias: $name } - | { foo: "bar" } - ...

That way we can tell users that the syntax of the value of the extensions field is just that of jq, without additional restrictions.

Ok, that makes sense. I interpreted the O-RAN standard that is describing the extensions as key:value pair.
Thank you for the clarification, @jhernand.
Kindly take another look when you get the time and please let me know if this approach better suits the extension scenarios.

Your interpretation of the specification is correct, but this is about how we are implementing the addition of configurable extensions with jq. It looks good to me now. Thanks @irinamihai!

jhernand · 2024-02-21T08:25:34Z

internal/controllers/utils/utils_test.go

+})
+
+var _ = Describe("DoesK8SResourceExist", func() {
+


Do these tests belong here? The aren't related to extensions. May this be a copy & paste error?

I included some extra testcases in this PR. I can add them separately in another PR.

That is fine, keep them.

openshift-ci-robot · 2024-02-21T23:10:47Z

@irinamihai: This pull request references MGMT-16144 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

Description:

Add a new array type Spec field called Extensions

As per O-RAN.WG6.O2IMS-INTERFACE-R003-v04.00, this new field is of key:value format and it has been implemented as an array of strings

In the ORANO2IMS CR definition, the Extensions can be declared as follows:
 spec:
   extensions:
   - "{\"country\": .metadata.labels[\"country\"]}"
   - "{\"my\": {memory: .status.capacity.memory, k8s_version: .status.version.kubernetes}}"
   - |
        .metadata.labels["name"] as $name |
        {
          name: $name,
         alias: $name
        }
Each element of Spec.Extensions will be translated in an --extensions argument for the deployment manager server:
"--extensions={\"country\": .metadata.labels[\"country\"]}","--extensions={\"my\": {memory: .status.capacity.memory, k8s_version: .status.version.kubernetes}}","--extensions=.metadata.labels[\"name\"] as $name |\n{\n  name: $name,\n  alias: $name\n}\n"]
a request for extensions to the deployment manager server done in a regular hub environment with one managed cluster would return as follows:
# ./get_oran '/o2ims-infrastructureInventory/v1/deploymentManagers?fields=extensions'

[
 {
   "extensions": {
     "country": "Canada",
     "my": {
       "k8s_version": "v1.27.8+4fab27b",
       "memory": "32856932Ki"
     },
     "alias": "spoke-hub-spoke-1",
     "name": "spoke-hub-spoke-1"
   }
 }
]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

Description: - Add a new array type Spec field called Extensions - As per O-RAN.WG6.O2IMS-INTERFACE-R003-v04.00, this new field is of key:value format and it has been implemented as an array of strings - in the ORANO2IMS CR definition, the Extensions can be declared as follows: spec: extensions: - "{\"country\": .metadata.labels[\"country\"]}" - "{\"aaaa\": {memory: .status.capacity.memory, k8s_version: .status.version.kubernetes}}" - | .metadata.labels["name"] as $name | { name: $name, alias: $name }

jhernand · 2024-02-22T08:05:09Z

/lgtm

openshift-ci bot requested review from danielerez and jhernand February 20, 2024 23:39

jhernand reviewed Feb 21, 2024

View reviewed changes

irinamihai force-pushed the operator_extensions branch from 6ab06ea to f3b726c Compare February 21, 2024 22:49

irinamihai force-pushed the operator_extensions branch from f3b726c to 538c341 Compare February 21, 2024 23:11

irinamihai requested a review from jhernand February 22, 2024 00:04

openshift-ci bot assigned jhernand Feb 22, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 22, 2024

irinamihai merged commit 7bfdd9f into openshift-kni:main Feb 22, 2024
7 of 8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MGMT-16144: Operator - Add extension support #65

MGMT-16144: Operator - Add extension support #65

irinamihai commented Feb 20, 2024 •

edited

Loading

openshift-ci-robot commented Feb 20, 2024 •

edited by openshift-ci bot

Loading

openshift-ci bot commented Feb 20, 2024

jhernand Feb 21, 2024

jhernand Feb 21, 2024

irinamihai Feb 21, 2024

jhernand Feb 22, 2024

jhernand Feb 21, 2024

irinamihai Feb 21, 2024

jhernand Feb 21, 2024

openshift-ci-robot commented Feb 21, 2024 •

edited by openshift-ci bot

Loading

jhernand commented Feb 22, 2024

MGMT-16144: Operator - Add extension support #65

MGMT-16144: Operator - Add extension support #65

Conversation

irinamihai commented Feb 20, 2024 • edited Loading

openshift-ci-robot commented Feb 20, 2024 • edited by openshift-ci bot Loading

openshift-ci bot commented Feb 20, 2024

jhernand Feb 21, 2024

Choose a reason for hiding this comment

jhernand Feb 21, 2024

Choose a reason for hiding this comment

irinamihai Feb 21, 2024

Choose a reason for hiding this comment

jhernand Feb 22, 2024

Choose a reason for hiding this comment

jhernand Feb 21, 2024

Choose a reason for hiding this comment

irinamihai Feb 21, 2024

Choose a reason for hiding this comment

jhernand Feb 21, 2024

Choose a reason for hiding this comment

openshift-ci-robot commented Feb 21, 2024 • edited by openshift-ci bot Loading

jhernand commented Feb 22, 2024

irinamihai commented Feb 20, 2024 •

edited

Loading

openshift-ci-robot commented Feb 20, 2024 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Feb 21, 2024 •

edited by openshift-ci bot

Loading