[doc] Adds operator deployment steps in OpenShift #132

alosadagrande · 2024-07-30T07:54:57Z

This PR updates documentation:

It divides the README into two main blocks: deployment via operator in OpenShift and local deployment (testing)
Deployment of the IMS operator on top of OpenShift
Configuration of the different microservices of the IMS operator using the ORANO2MS CR. There was no example of that CR in the repo.
Currently only metadata, deployment manager and resource server. The rest could be added once they are validated in the operator deployment.
An index is added to ease navigation through the information

Let me know your thoughts.

bartwensley · 2024-08-01T17:48:52Z

/cc @Missxiaoguo @irinamihai

Angie and Irina would be the best ones to review this.

README.md

openshift-ci · 2024-09-25T09:40:34Z

[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 assign alegacy for approval. 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

alosadagrande · 2024-09-25T09:41:12Z

Comments addressed. PTAL.

mmorency2021 · 2024-09-25T15:50:17Z

i have tried to test the CRs in this PR for instance the metadata Kind and also the api version seems wrong.
from this discussion : https://redhat-internal.slack.com/archives/C07A9NFCS01/p1726609509792089
the new kind used is : Inventory. and the api version is : o2ims.oran.openshift.io/v1alpha1.

README.md

bartwensley · 2024-11-13T19:58:30Z

@alosadagrande - it would be great if you could update this PR to address the comments and to incorporate the latest changes to how we deploy the operator.

Signed-off-by: Alberto Losada <[email protected]>

alosadagrande · 2024-11-15T11:56:36Z

@bartwensley @alegacy could you open it again, sorry not sure how it happened :(

README.md

alegacy · 2024-11-15T12:56:20Z

README.md

+    enabled: true
+  resourceServerConfig:
+    # A route must be created in the open-cluster-management namespace (RHACM) to expose the search collector Pod
+    backendURL: https://search-api-open-cluster-management.apps.hub0.inbound-int.se-lab.eng.rdu2.dc.redhat.com


The backendURL is optionally and shouldn't be used in this example.

But it is necessary to query the different resources, right? should we include a link or information to enable the searchCollector in a different section then?

No, this is an optional field. We can auto-detect it if not provided.

mmm yesterday @nocturnalastro was creating his environment and it was required to expose the searchCollector API as a route at least

That's a bit surprising since we access the service directly but at the very least it does not need to be specified in the Inventory CR.

README.md

…operator

alegacy · 2024-11-15T15:17:55Z

README.md

+  smo:
+    url: http://smo.example.com
+    registrationEndpoint: /mock_smo/v1/ocloud_observer
+  #image: quay.io/NAMESPACE/CONTAINER_IMAGE // uncomment if you want to use your built image otherwise will be populated with the default image.


The comment here is not accurate. If using make deploy the image used will be the user's development image. The only reason to use this is if for some reason someone wanted to use a completely different image. I would prefer if we removed this comment.

alegacy · 2024-11-15T15:18:19Z

README.md

+  cloudID: f7fd171f-57b5-4a17-b176-9a73bf6064a4
+  deploymentManagerServerConfig:
+    enabled: true
+    #examples of using the extensions spec


This comment can be removed as well.

alegacy · 2024-11-15T15:20:08Z

README.md

@@ -145,31 +394,43 @@ $ ./oran-o2ims start resource-server --help
 Inside _VS Code_ use the _Run and Debug_ option with the `start
 resource-server` [configuration](.vscode/launch.json).

-##### Requests Examples
+#### <a name='InfrastructureInventorySubscriptionServerResourceServer'></a>Infrastructure Inventory Subscription Server (Resource Server)


This section on the inventory subscription server can now be removed. It has been incorporated directly into the resource server component.

alegacy · 2024-11-15T15:22:35Z

README.md

+To get the api versions supported
+
+```sh
+$ curl --insecure --silent --header "Authorization: Bearer $MY_TOKEN" 


We should be consistent with the use of brackets around variables. ${MY_TOKEN} rather than $MY_TOKEN

alegacy · 2024-11-15T15:24:32Z

README.md

+
+### <a name='QuerytheInfrastructureInventorySubscriptionResourceServer'></a>Query the Infrastructure Inventory Subscription (Resource Server)
+
+#### <a name='GETInfrastructureInventorySubscriptionList'></a>GET Infrastructure Inventory Subscription List

 To get a list of resource subscriptions:

 ```
 $ curl -s http://localhost:8004/o2ims-infrastructureInventory/v1/subscriptions | jq


These next few curl commands also need the Authorization header... sorry, my mistake for missing that when I moved these lines.

alegacy · 2024-11-15T15:27:10Z

README.md

+```sh
+$ oc get route -n oran-o2ims
+NAME        HOST/PORT                                                   PATH                                                   SERVICES                    PORT   TERMINATION          WILDCARD
+api-2fv99   o2ims.apps.hub0.inbound-int.se-lab.eng.rdu2.dc.redhat.com   /                                                      metadata-server             api    reencrypt/Redirect   None


we might want to remove all of the lab URIs and replace with apps.example.com

bartwensley

Looks good - just a couple minor comments.

bartwensley · 2024-11-15T19:17:46Z

README.md

+hack/install_test_deps.sh
+Downloading golangci-lint
+… REDACTED …
+/home/alosadag/Documents/CNF/ORAN/oran-o2ims/bin/kustomize build config/default | /home/alosadag/Documents/CNF/ORAN/oran-o2ims/bin/kubectl apply -f -


Should probably remove the path and just start with .../oran-o2ims - also should remove any occurrences of your username and replace with (maybe those will all disappear with the path though).

bartwensley · 2024-11-15T19:24:00Z

README.md

+api-2fv99   o2ims.apps.hub0.inbound-int.se-lab.eng.rdu2.dc.redhat.com   /                                                      metadata-server             api    reencrypt/Redirect   None
+api-cbvbz   o2ims.apps.hub0.inbound-int.se-lab.eng.rdu2.dc.redhat.com   /o2ims-infrastructureInventory/v1/resourceTypes        resource-server             api    reencrypt/Redirect   None
+api-v92jb   o2ims.apps.hub0.inbound-int.se-lab.eng.rdu2.dc.redhat.com   /o2ims-infrastructureInventory/v1/deploymentManagers   deployment-manager-server   api    reencrypt/Redirect   None
+api-xllml   o2ims.apps.hub0.inbound-int.se-lab.eng.rdu2.dc.redhat.com   /o2ims-infrastructureInventory/v1/resourcePools        resource-server             api    reencrypt/Redirect   None


Shouldn't use real FQDNs in your examples - please change the "se-lab.eng.rdu2.dc" part to something generic or a placeholder.

openshift-ci bot requested review from bartwensley and donpenney July 30, 2024 07:55

openshift-ci bot requested review from irinamihai and Missxiaoguo August 1, 2024 17:48

dav1x reviewed Aug 19, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

alosadagrande force-pushed the doc-operator branch from b6b5360 to 89f950d Compare September 25, 2024 09:40

alegacy reviewed Sep 25, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Sep 25, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Sep 25, 2024

View reviewed changes

README.md Show resolved Hide resolved

alegacy reviewed Sep 25, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Sep 25, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

bartwensley mentioned this pull request Oct 16, 2024

Starting Metadata service automatically #260

Closed

Adds operator deployment steps in OpenShift

44bb14c

Signed-off-by: Alberto Losada <[email protected]>

alosadagrande force-pushed the doc-operator branch 6 times, most recently from c43b6d1 to a8b232b Compare November 15, 2024 11:45

alosadagrande closed this Nov 15, 2024

alegacy reopened this Nov 15, 2024

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

alegacy reviewed Nov 15, 2024

View reviewed changes

README.md Show resolved Hide resolved

alosadagrande force-pushed the doc-operator branch 2 times, most recently from 90c9cbd to 67df9a2 Compare November 15, 2024 14:48

Re-structuring the documentation adding steps to deploy the o2ims as …

ce1bd35

…operator

alosadagrande force-pushed the doc-operator branch from 67df9a2 to ce1bd35 Compare November 15, 2024 14:55

alegacy reviewed Nov 15, 2024

View reviewed changes

bartwensley reviewed Nov 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc] Adds operator deployment steps in OpenShift #132

[doc] Adds operator deployment steps in OpenShift #132

alosadagrande commented Jul 30, 2024 •

edited

Loading

bartwensley commented Aug 1, 2024

openshift-ci bot commented Sep 25, 2024

alosadagrande commented Sep 25, 2024

mmorency2021 commented Sep 25, 2024

bartwensley commented Nov 13, 2024 •

edited

Loading

alosadagrande commented Nov 15, 2024

alegacy Nov 15, 2024

alosadagrande Nov 15, 2024

alegacy Nov 15, 2024

alosadagrande Nov 15, 2024

alegacy Nov 15, 2024

alegacy Nov 15, 2024

alegacy Nov 15, 2024

alegacy Nov 15, 2024

alegacy Nov 15, 2024

alegacy Nov 15, 2024

alegacy Nov 15, 2024

bartwensley left a comment

bartwensley Nov 15, 2024

bartwensley Nov 15, 2024

[doc] Adds operator deployment steps in OpenShift #132

Are you sure you want to change the base?

[doc] Adds operator deployment steps in OpenShift #132

Conversation

alosadagrande commented Jul 30, 2024 • edited Loading

bartwensley commented Aug 1, 2024

openshift-ci bot commented Sep 25, 2024

alosadagrande commented Sep 25, 2024

mmorency2021 commented Sep 25, 2024

bartwensley commented Nov 13, 2024 • edited Loading

alosadagrande commented Nov 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bartwensley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alosadagrande commented Jul 30, 2024 •

edited

Loading

bartwensley commented Nov 13, 2024 •

edited

Loading