Skip to content

Commit

Permalink
Merge pull request openshift#602 from tmshort/update-docs
Browse files Browse the repository at this point in the history 
NO-ISSUE: Update downstreaming documentation.
  • Loading branch information
@openshift-ci @grokspawn
openshift-ci[bot] authored and grokspawn committed Nov 2, 2023
2 parents 57e26f0 + 2765998 commit 6137eb2
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 12 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Expand Up @@ -14,3 +14,5 @@ above), and then downstreamed to this repository.

Please refer to the [scripts README.md](scripts/README.md) to learn how to
downstream commits from those projects to this repo.

A [TestGrid](https://testgrid.k8s.io/redhat-openshift-olm) is configured for this repository.
6 changes: 0 additions & 6 deletions go.mod
View file
Expand Up @@ -256,10 +256,4 @@ replace (
github.com/operator-framework/api => ./staging/api
github.com/operator-framework/operator-lifecycle-manager => ./staging/operator-lifecycle-manager
github.com/operator-framework/operator-registry => ./staging/operator-registry

// this should be removeable once https://issues.redhat.com/browse/CLOUDBLD-11068 is resolved
k8s.io/pod-security-admission => k8s.io/pod-security-admission v0.25.0

// pinned because no tag supports 1.18 yet
sigs.k8s.io/structured-merge-diff => sigs.k8s.io/structured-merge-diff v1.0.1-0.20191108220359-b1b620dd3f06
)
20 changes: 20 additions & 0 deletions manifests/0000_50_olm_00-clusterserviceversions.crd.yaml
View file
Expand Up @@ -1700,7 +1700,11 @@ spec:
type: object
properties:
claims:
<<<<<<< HEAD
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
=======
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
>>>>>>> 07c80820c (bump golang-migrate to v4.16.1 (#1107))
type: array
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
Expand Down Expand Up @@ -2544,7 +2548,11 @@ spec:
type: object
properties:
claims:
<<<<<<< HEAD
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
=======
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
>>>>>>> 07c80820c (bump golang-migrate to v4.16.1 (#1107))
type: array
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
Expand Down Expand Up @@ -3399,7 +3407,11 @@ spec:
type: object
properties:
claims:
<<<<<<< HEAD
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
=======
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
>>>>>>> 07c80820c (bump golang-migrate to v4.16.1 (#1107))
type: array
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
Expand Down Expand Up @@ -3766,7 +3778,11 @@ spec:
description: If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
type: string
schedulingGates:
<<<<<<< HEAD
description: "SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. \n SchedulingGates can only be set at pod creation time, and be removed only afterwards. \n This is a beta feature enabled by the PodSchedulingReadiness feature gate."
=======
description: "SchedulingGates is an opaque list of values that if specified will block scheduling the pod. More info: https://git.k8s.io/enhancements/keps/sig-scheduling/3521-pod-scheduling-readiness. \n This is an alpha-level feature enabled by PodSchedulingReadiness feature gate."
>>>>>>> 07c80820c (bump golang-migrate to v4.16.1 (#1107))
type: array
items:
description: PodSchedulingGate is associated to a Pod to guard its scheduling.
Expand Down Expand Up @@ -4294,7 +4310,11 @@ spec:
type: object
properties:
claims:
<<<<<<< HEAD
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
=======
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
>>>>>>> 07c80820c (bump golang-migrate to v4.16.1 (#1107))
type: array
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
Expand Down
8 changes: 8 additions & 0 deletions manifests/0000_50_olm_00-subscriptions.crd.yaml
View file
Expand Up @@ -647,7 +647,11 @@ spec:
type: object
properties:
claims:
<<<<<<< HEAD
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
=======
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
>>>>>>> 07c80820c (bump golang-migrate to v4.16.1 (#1107))
type: array
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
Expand Down Expand Up @@ -1073,7 +1077,11 @@ spec:
type: object
properties:
claims:
<<<<<<< HEAD
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
=======
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
>>>>>>> 07c80820c (bump golang-migrate to v4.16.1 (#1107))
type: array
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
Expand Down
26 changes: 22 additions & 4 deletions scripts/README.md
View file
Expand Up @@ -5,6 +5,17 @@ All of the staged repositories live in the top level `staging` directory.
The downstreaming process is complex and helper scripts have been written
to facilitate downstreaming.

## Automatic Downstreaming

There is now an automated downstreaming process for OLMv0 from the three
source repositories.

The "bumper" program is located in [openshift/operator-framework-tooling](https://github.com/openshift/operator-framework-tooling).
It is automatically run on a daily basis based on the following [openshift/release](https://github.com/openshift/release/blob/3bf0b3ae011debaefefb564ad6f233c380d033f7/ci-operator/jobs/infra-periodics.yaml#L926-L978) config.

If the bumper program fails to create a mergeable PR, manual intervention will be necessary.
This may require copying, modifying and resubmitting the PR.

## Assumptions

The helper scripts assume that the upstream remote repos are configured
Expand All @@ -19,6 +30,9 @@ remote repositories.

## Bulk Sync

**NOTE**: This should no longer be necessary, given the "bumper" program above.
The "bumper" program can be used instead of the following process.

To sync all current changes from upstream, simply run the sync script:
```sh
scripts/sync.sh
Expand Down Expand Up @@ -54,14 +68,18 @@ file in the repositry root directory with the repos and commit SHAs.

The format of the cherrypick file is:
```
<order> <repo> <commit-SHA>
<date-order> <commit-order> <repo> <commit-SHA>
```

* The `<date-order>` field is usually an ISO date without spaces.
* The `<commit-order>` field is a sequential number indicating the order of a commit within a pull request.
* For this _manual_ purpose, both can just be the same sequential number.

For example:
```
1 api 0123456789abcdef0123456789abcdef01234567
2 operator-lifecycle-manager 123456789abcdef0123456789abcdef012345678
3 operator-lifecycle-manager 23456789abcdef0123456789abcdef0123456789
1 1 api 0123456789abcdef0123456789abcdef01234567
2 2 operator-lifecycle-manager 123456789abcdef0123456789abcdef012345678
3 3 operator-lifecycle-manager 23456789abcdef0123456789abcdef0123456789
```
Do _not_ commit the cherrypick file, it is a temporary working file that
is ignored by `git`.
Expand Down
2 changes: 0 additions & 2 deletions vendor/modules.txt
View file
Expand Up @@ -2263,5 +2263,3 @@ sigs.k8s.io/yaml
# github.com/operator-framework/api => ./staging/api
# github.com/operator-framework/operator-lifecycle-manager => ./staging/operator-lifecycle-manager
# github.com/operator-framework/operator-registry => ./staging/operator-registry
# k8s.io/pod-security-admission => k8s.io/pod-security-admission v0.25.0
# sigs.k8s.io/structured-merge-diff => sigs.k8s.io/structured-merge-diff v1.0.1-0.20191108220359-b1b620dd3f06

0 comments on commit 6137eb2

Please sign in to comment.