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

OCPBUGS-28538: Added docs to get other sdn providers deployed with agent provider #3405

Merged
merged 1 commit into from Feb 13, 2024

Conversation

mvazquezc
Copy link
Member

What this PR does / why we need it:
This PR adds docs to the agent provider section on how to get other SDN providers (Calico and Cilium) deployed in a HostedCluster.

Which issue(s) this PR fixes (optional, use fixes #<issue_number>(, fixes #<issue_number>, ...) format, where issue_number might be a GitHub issue, or a Jira story:
None

Checklist

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.
  • This change includes docs.
  • This change includes unit tests.

@openshift-ci openshift-ci bot added area/documentation Indicates the PR includes changes for documentation and removed do-not-merge/needs-area labels Jan 11, 2024
Copy link

netlify bot commented Jan 11, 2024

Deploy Preview for hypershift-docs ready!

Name Link
🔨 Latest commit 68d09f0
🔍 Latest deploy log https://app.netlify.com/sites/hypershift-docs/deploys/65cbd70ee373010008be9b3d
😎 Deploy Preview https://deploy-preview-3405--hypershift-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mvazquezc mvazquezc changed the title docs: Added docs to get other sdn providers deployed with agent provider OCPBUGS-26977: Added docs to get other sdn providers deployed with agent provider Jan 11, 2024
@openshift-ci-robot openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Jan 11, 2024
@openshift-ci-robot
Copy link

@mvazquezc: This pull request references Jira Issue OCPBUGS-26977, which is invalid:

  • expected the bug to target the "4.16.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

What this PR does / why we need it:
This PR adds docs to the agent provider section on how to get other SDN providers (Calico and Cilium) deployed in a HostedCluster.

Which issue(s) this PR fixes (optional, use fixes #<issue_number>(, fixes #<issue_number>, ...) format, where issue_number might be a GitHub issue, or a Jira story:
None

Checklist

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.
  • This change includes docs.
  • This change includes unit tests.

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.


This document explains how to create a HostedCluster that runs an SDN provider different from OVNKubernetes. The document assumes that you already have the required infrastructure in place to create HostedClusters using the Agent provider. If not, please refer to the [Agent guide](./create-agent-cluster.md) and come back later.

> **IMPORTANT**: The work described here is **not supported**. SDN providers **must** certify their software on HyperShift before it becomes a supported solution. The steps described here are just a technical reference for people that wants to try different SDN providers in HyperShift.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> **IMPORTANT**: The work described here is **not supported**. SDN providers **must** certify their software on HyperShift before it becomes a supported solution. The steps described here are just a technical reference for people that wants to try different SDN providers in HyperShift.
> **IMPORTANT**: The work described here is **not supported**. SDN providers **must** certify their software on HyperShift before it becomes a supported solution. The steps described here are just a technical reference for people who want to try different SDN providers in HyperShift.

Copy link
Member

Choose a reason for hiding this comment

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

You'll need to modify mkdocs.yml as well to include this in the directory.

- how-to/agent/create-agent-cluster.md

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 13, 2024
@jparrill
Copy link
Contributor

Handing this PR over meanwhile @mvazquezc is OoO.

@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 13, 2024
@jparrill
Copy link
Contributor

/retitle OCPBUGS-26977,OCPBUGS-28538: Added docs to get other sdn providers deployed with agent provider

@openshift-ci openshift-ci bot changed the title OCPBUGS-26977: Added docs to get other sdn providers deployed with agent provider OCPBUGS-26977,OCPBUGS-28538: Added docs to get other sdn providers deployed with agent provider Feb 13, 2024
@openshift-ci-robot openshift-ci-robot added the jira/severity-critical Referenced Jira bug's severity is critical for the branch this PR is targeting. label Feb 13, 2024
@openshift-ci-robot
Copy link

@mvazquezc: This pull request references Jira Issue OCPBUGS-26977, which is invalid:

  • expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is Verified instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

This pull request references Jira Issue OCPBUGS-28538, which is invalid:

  • expected the bug to target the "4.16.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

What this PR does / why we need it:
This PR adds docs to the agent provider section on how to get other SDN providers (Calico and Cilium) deployed in a HostedCluster.

Which issue(s) this PR fixes (optional, use fixes #<issue_number>(, fixes #<issue_number>, ...) format, where issue_number might be a GitHub issue, or a Jira story:
None

Checklist

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.
  • This change includes docs.
  • This change includes unit tests.

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.

@jparrill
Copy link
Contributor

/retitle OCPBUGS-28538: Added docs to get other sdn providers deployed with agent provider

@openshift-ci openshift-ci bot changed the title OCPBUGS-26977,OCPBUGS-28538: Added docs to get other sdn providers deployed with agent provider OCPBUGS-28538: Added docs to get other sdn providers deployed with agent provider Feb 13, 2024
Copy link
Contributor

@csrwng csrwng left a comment

Choose a reason for hiding this comment

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

a couple of comments


2. Wait for the HostedCluster's API to be ready. Once it's ready, get the admin kubeconfig.

3. Wait for compute nodes to join the cluster. Keep in mind since the SDN is not deployed yet, they will remain in `NotReady` state.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it's necessary to wait for nodes to join. You should be able to apply the manifests as long as you have a working API server.

Copy link
Contributor

Choose a reason for hiding this comment

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

fixed


2. Wait for the HostedCluster's API to be ready. Once it's ready, get the admin kubeconfig.

3. Wait for compute nodes to join the cluster. Keep in mind since the SDN is not deployed yet, they will remain in `NotReady` state.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above, no need to wait for nodes.

Copy link
Contributor

Choose a reason for hiding this comment

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

fixed

@jparrill
Copy link
Contributor

/jira refresh

@openshift-ci-robot
Copy link

@jparrill: This pull request references Jira Issue OCPBUGS-28538, which is invalid:

  • expected the bug to target the "4.16.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

/jira refresh

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.

@jparrill jparrill force-pushed the other-sdn-docs branch 2 times, most recently from 1fbaf69 to 5634e61 Compare February 13, 2024 18:15
This PR includes Cilium and Calico SDNs to have them configured in the
Hosted Cluster. In the Cilium part also covers some conformance tests
that could be deployed into the HostedCluster to validate that the SDN
is working as expected.

Signed-off-by: Mario Vazquez <mavazque@redhat.com>
Signed-off-by: Juan Manuel Parrilla Madrid <jparrill@redhat.com>

This commit includes the fixes for versions 4.14.10 and also from 4.15.z, making Cilium work as SDN properly. Also included configurations for IPv6 and Dual Stack.

Signed-off-by: Juan Manuel Parrilla Madrid <jparrill@redhat.com>
@jparrill
Copy link
Contributor

/jira refresh

@openshift-ci-robot openshift-ci-robot added the jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. label Feb 13, 2024
@openshift-ci-robot
Copy link

@jparrill: This pull request references Jira Issue OCPBUGS-28538, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target version (4.16.0) matches configured target version for branch (4.16.0)
  • bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

No GitHub users were found matching the public email listed for the QA contact in Jira (heli@redhat.com), skipping review request.

In response to this:

/jira refresh

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-robot openshift-ci-robot removed the jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. label Feb 13, 2024
@jparrill
Copy link
Contributor

/approve

Copy link
Contributor

openshift-ci bot commented Feb 13, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jparrill, mvazquezc

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

The pull request process is described 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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 13, 2024
Copy link
Contributor

openshift-ci bot commented Feb 13, 2024

@mvazquezc: all tests passed!

Full PR test history. Your PR dashboard.

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 kubernetes/test-infra repository. I understand the commands that are listed here.

@csrwng
Copy link
Contributor

csrwng commented Feb 13, 2024

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 13, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit a58035c into openshift:main Feb 13, 2024
8 checks passed
@openshift-ci-robot
Copy link

@mvazquezc: Jira Issue OCPBUGS-28538: All pull requests linked via external trackers have merged:

Jira Issue OCPBUGS-28538 has been moved to the MODIFIED state.

In response to this:

What this PR does / why we need it:
This PR adds docs to the agent provider section on how to get other SDN providers (Calico and Cilium) deployed in a HostedCluster.

Which issue(s) this PR fixes (optional, use fixes #<issue_number>(, fixes #<issue_number>, ...) format, where issue_number might be a GitHub issue, or a Jira story:
None

Checklist

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.
  • This change includes docs.
  • This change includes unit tests.

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

[ART PR BUILD NOTIFIER]

This PR has been included in build ose-hypershift-container-v4.16.0-202402140210.p0.ga58035c.assembly.stream.el9 for distgit hypershift.
All builds following this will include this PR.

@jparrill
Copy link
Contributor

The backport is not needed because it's only documentation, but the affectation it's also covering 4.14 OCP versions.

@openshift-merge-robot
Copy link
Contributor

Fix included in accepted release 4.16.0-0.nightly-2024-02-17-013806

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation Indicates the PR includes changes for documentation jira/severity-critical Referenced Jira bug's severity is critical for the branch this PR is targeting. jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants