Skip to content

Commit

Permalink
Update naming of config keys, filenames, references and code to remov…
Browse files Browse the repository at this point in the history
…e obsolete terms (#103)

* Update refs of ciam-rebac to relations-api, incl packages, protos, binary, docker and generated files.

* Update deployment script and Makefile to replace insights-rebac with relations-api.

* Update make targets and README to replace references of rebac.

* Change test temp dir from rebac to relations-api.

* Replace rebac with relations-api in docker compose config.

* Replace referenes of rebac with relations-api in kind config.

* Change go mod and package to add domain namespacing (github.com/project-kessel).

* Remove ;v1 from the end of go_packages in proto files and regenerate code.

* Change binary name from relations-api to kessel-relations.
  • Loading branch information
merlante authored Jun 18, 2024
1 parent e0242c0 commit a77c3bb
Show file tree
Hide file tree
Showing 47 changed files with 180 additions and 171 deletions.
10 changes: 5 additions & 5 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ RUN make build
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.10


COPY --from=builder /workspace/bin/ciam-rebac /usr/local/bin/
COPY --from=builder /workspace/bin/kessel-relations /usr/local/bin/
COPY --from=builder /workspace/configs/config.yaml /usr/local/bin/

EXPOSE 8000
EXPOSE 9000

USER 1001

ENTRYPOINT ["/usr/local/bin/ciam-rebac","-conf","/usr/local/bin/config.yaml"]
ENTRYPOINT ["/usr/local/bin/kessel-relations","-conf","/usr/local/bin/config.yaml"]

LABEL name="ciam-rebac" \
LABEL name="kessel-relations-api" \
version="0.0.1" \
summary="ciam-rebac service" \
description="rebac"
summary="Kessel relations-api service" \
description="The Kessel relations-api service"
26 changes: 13 additions & 13 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,25 +85,25 @@ pr-check:
make lint;
make build;

spicedb:
spicedb-up:
./spicedb/start-spicedb.sh
.PHONY: spicedb
.PHONY: spicedb-up

rebac:
./spicedb/start-insights-rebac.sh
.PHONY: rebac
relations-api-up:
./spicedb/start-relations-api.sh
.PHONY: relations-api-up

rebac/teardown:
./spicedb/teardownrebac.sh
.PHONY: rebac/teardown
relations-api-down:
./spicedb/stop-relations-api.sh
.PHONY: relations-api-down

spicedb/teardown:
spicedb-down:
./spicedb/teardown.sh
.PHONY: spicedb/teardown
.PHONY: spicedb-down

kind/rebac:
kind/relations-api:
./spicedb-kind-setup/setup.sh
.PHONY: kind/spicedb
.PHONY: kind/relations-api

kind/teardown:
./spicedb-kind-setup/teardown.sh
Expand All @@ -112,7 +112,7 @@ kind/teardown:
.PHONY: run
# run api locally
run: build
./bin/ciam-rebac -conf configs
./bin/kessel-relations -conf configs

# show help
help:
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ See also:

`make build`

(Configs must be specified to run binary, e.g. `./bin/ciam-rebac -conf configs`, or run make target, below.)
(Configs must be specified to run binary, e.g. `./bin/kessel-relations -conf configs`, or run make target, below.)

### Run

Expand Down Expand Up @@ -74,28 +74,28 @@ wire

### Run spicedb and postgresql db with docker/podman compose

`make spicedb`
`make spicedb-up`

This is a good option for keeping spicedb running in the background while the rebac service is run via
This is a good option for keeping spicedb running in the background while the relations-api service is run via
`make run`, the binary or via the IDE (run/debug) during local development.

### Run the insights-rebac and spicedb with docker/podman compose
### Run the relations-api and spicedb with docker/podman compose

`make rebac`
`make relations-api-up`

This runs everything and is a good option for testing a built rebac container image with the running binary.
This runs everything and is a good option for testing a built relations-api container image with the running binary.

### Teardown spicedb and postgresql db (brought up with docker/podman compose, as above)

`make spicedb/teardown`
`make spicedb-down`

### Teardown rebac and dependencies (brought up with docker/podman compose, as above)
### Teardown relations-api and dependencies (brought up with docker/podman compose, as above)

`make rebac/teardown`
`make relations-api-down`

### Deploy Rebac and Spicedb using kind/kubernetes
### Deploy relations-api and spicedb using kind/kubernetes

`make kind/rebac`
`make kind/relations-api`

### Docker

Expand Down Expand Up @@ -159,7 +159,7 @@ You should be able to use the public route (relations-\*) created by the clowder
This is demonstrating calling relationship api from rbac service in ephemeral environment.

```
./deploy.sh rbac <path_to_local_copy_of_insights_rbac>
./deploy.sh rbac <path_to_local_copy_of_relations-api>
```
`path_to_local_copy_of_insights_rbac` is this [repository](https://github.com/RedHatInsights/insights-rbac)
Expand Down
23 changes: 12 additions & 11 deletions api/health/v1/health.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/health/v1/health.proto
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package kessel.relations.v1;

import "google/api/annotations.proto";

option go_package = "ciam-rebac/api/health/v1;v1";
option go_package = "github.com/project-kessel/relations-api/api/health/v1";
option java_multiple_files = true;
option java_package = "org.project_kessel.api.relations.v1";

Expand Down
2 changes: 1 addition & 1 deletion api/health/v1/health_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/health/v1/health_http.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 11 additions & 10 deletions api/relations/v0/check.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/relations/v0/check.proto
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package kessel.relations.v0;
import "google/api/annotations.proto";
import "relations/v0/common.proto";

option go_package = "ciam-rebac/api/relations/v0;v0";
option go_package = "github.com/project-kessel/relations-api/api/relations/v0";
option java_multiple_files = true;
option java_package = "org.project_kessel.api.relations.v0";

Expand Down
2 changes: 1 addition & 1 deletion api/relations/v0/check_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/relations/v0/check_http.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a77c3bb

Please sign in to comment.