Skip to content

Commit

Permalink
Remove openshift-dev-helpers and related
Browse files Browse the repository at this point in the history
  • Loading branch information
soltysh committed Oct 16, 2019
1 parent a35ef9a commit 1dfe071
Show file tree
Hide file tree
Showing 21 changed files with 10 additions and 2,503 deletions.
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,3 @@
# Output of the go coverage tool, specifically when used with LiteIDE
*.out

/openshift-dev-helpers
/openshift-must-gather

must-gather
17 changes: 8 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
all: build
all: images
.PHONY: all

# Include the library makefile
include $(addprefix ./vendor/github.com/openshift/library-go/alpha-build-machinery/make/, \
golang.mk \
targets/openshift/bindata.mk \
targets/openshift/images.mk \
)

IMAGE_REGISTRY :=registry.svc.ci.openshift.org

# This will call a macro called "build-image" which will generate image specific targets based on the parameters:
# $0 - macro name
# $1 - target suffix
# $2 - Dockerfile path
# $3 - context directory for image build
# It will generate target "image-$(1)" for builing the image an binding it as a prerequisite to target "images".
$(call build-image,origin-$(GO_PACKAGE),./Dockerfile,.)

# $1 - target name
# $2 - image ref
# $3 - Dockerfile path
# $4 - context directory for image build
$(call build-image,ocp-must-gather,$(IMAGE_REGISTRY)/ocp/4.2:ocp-must-gater, ./Dockerfile.rhel7,.)
39 changes: 2 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,10 @@ must-gather

`openshift-must-gather` is a tool for collecting cluster data.
It dumps `clusteroperator` data, and associated namespace data, into a specified `--base-dir` location.
The directory structure, as well as specific details behind this tool can be found [in this doc](https://docs.google.com/document/d/1v975fm3bjVzTPmtWYW0TQB05P3PPWUgG4AFGjD8lmOU/edit#heading=h.xbqgzreoju2s).
The directory structure, as well as specific details behind this tool can be found [in this enhancement](https://github.com/openshift/enhancements/blob/master/enhancements/must-gather.md).

## Collection Scripts
Data collection scripts are kept in `./collection-scripts`. The content of that folder is placed in `/usr/bin` in the image.
The data collection scripts should only include collection logic for components that are included as part of the OpenShift
CVO payload. Outside components are encouraged to produce a similar "must-gather" image, but this is not the spot to be
included.

### Building

Place in GOPATH under `src/github.com/openshift/must-gather`.

Build with:
```
$ make
```

**Before Running**: Make sure you have a `KUBECONFIG` environment variable set, and that it points to a valid admin kubeconfig file.
Alternatively, provide a filepath to a valid `admin.kubeconfig` file via the `--kubeconfig` flag.

Run with:
```
./bin/openshift-must-gather inspect clusteroperator/<name>
```

Note: it is possible to run this tool to collect all clusteroperator data by omitting a `<name>`:

```
./bin/openshift-must-gather inspect clusteroperators
```

#### Developers Only

**WARNING**: The following tool is provided with no guarantees and might (and will) be changed at any time. Please do not rely on anything below in your scripts or automatization.

Beside the `oppenshift-must-gather` binary the `openshift-dev-helpers` binary is also provided. This binary combines various
tools useful for the OpenShift developers teams.

To list all events recorded during a test run and stored in `events.json` file, you can run this command:
```bash
./bin/openshift-dev-helpers events https://storage.googleapis.com/origin-ci-test/pr-logs/.../artifacts/e2e-aws/events.json --component=openshift-apiserver-operator
```
included.
82 changes: 0 additions & 82 deletions cmd/openshift-dev-helpers/main.go

This file was deleted.

Loading

0 comments on commit 1dfe071

Please sign in to comment.