Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Adds operator deployment steps in OpenShift #132

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

alosadagrande
Copy link
Contributor

@alosadagrande alosadagrande commented Jul 30, 2024

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
Copy link
Collaborator

/cc @Missxiaoguo @irinamihai

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

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
Copy link

openshift-ci bot commented Sep 25, 2024

[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:

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

@alosadagrande
Copy link
Contributor Author

Comments addressed. PTAL.

@mmorency2021
Copy link

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.

enabled: false
cloudId: c0332915-6bff-4d8d-8628-0ab3cc2c7e5e
deploymentManagerServerConfig:
backendToken: ${BACKEND_TOKEN}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The backendToken is not required. The server will automatically use its serviceaccount token to access other services; therefore this line and line 163 are not necessary.

backendToken: ${BACKEND_TOKEN}
backendType: regular-hub
enabled: true
image: quay.io/openshift-kni/oran-o2ims:4.16.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image is also not necessary since the controller will inherit the value passed into its IMAGE environment variable which is part of the default deployment and bundled deployment.

cloudId: c0332915-6bff-4d8d-8628-0ab3cc2c7e5e
deploymentManagerServerConfig:
backendToken: ${BACKEND_TOKEN}
backendType: regular-hub
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the default value for backendType so not really necessary.

oc get route -n open-cluster-management search-api -o json |
jq -r '"https://" + .spec.host'
)
$ export BACKEND_TOKEN_RS=$(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above regarding the backend token. It is not necessary to specify one since the server will use its serviceaccount token automatically.

namespace/oran-o2ims created
```

#### 1.2.1. <a name='Metadataserver'></a>Metadata server
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document has been structured to start the servers one at a time, but in practice that is not typically how it would be done. The Inventory CR would be added with all of the fields set to true in one operation. There is no need to do them one at a time -- it really only inflates how many documentation lines that need to be managed and the number of steps to be tested. IMHO, it would be sufficient/best to simply 1) add the Inventory CR, and 2) verify the endpoints

@bartwensley
Copy link
Collaborator

bartwensley commented Nov 13, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants