Skip to content

Commit

Permalink
rename project to fybrik (#94)
Browse files Browse the repository at this point in the history
* rename project to fybrik

Signed-off-by: Doron Chen <[email protected]>

* fix fybrik.io -> fybrik

Signed-off-by: Doron Chen <[email protected]>

* fix Revital's comments

Signed-off-by: Doron Chen <[email protected]>
  • Loading branch information
cdoron authored Aug 1, 2021
1 parent 6c5cd37 commit b472f4f
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 24 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Ask a Question
url: https://github.com/mesh-for-data/the-mesh-for-data-flight-module/discussions/new?category=q-a
url: https://github.com/fybrik/arrow-flight-module/discussions/new?category=q-a
about: Ask the community for help
- name: Feature Request
url: https://github.com/mesh-for-data/the-mesh-for-data-flight-module/discussions/new?category=ideas
url: https://github.com/fybrik/arrow-flight-module/discussions/new?category=ideas
about: Share ideas for new features
- name: Bug Report
url: https://github.com/mesh-for-data/the-mesh-for-data-flight-module/issues/new
url: https://github.com/fybrik/arrow-flight-module/issues/new
about: Report a reproducable bug
8 changes: 4 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ jobs:
pip install pipenv
- name: Build docker image
run: export REPOSITORY=ghcr.io/mesh-for-data/arrow-flight-module && make build
run: export REPOSITORY=ghcr.io/fybrik/arrow-flight-module && make build
- name: Docker login
if: ${{ github.event_name != 'pull_request' }}
run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login -u "mesh-for-data" --password-stdin "${{ env.DOCKER_HOSTNAME }}"
run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login -u "fybrik" --password-stdin "${{ env.DOCKER_HOSTNAME }}"
- name: Docker push
if: ${{ (github.event_name != 'pull_request') && !contains(github.ref, 'tags') }}
run: export REPOSITORY=ghcr.io/mesh-for-data/arrow-flight-module && make push
run: export REPOSITORY=ghcr.io/fybrik/arrow-flight-module && make push
- id: version
name: Infer version
run: echo ::set-output name=version::${GITHUB_REF#refs/*/}
Expand All @@ -48,4 +48,4 @@ jobs:
run: export HELM_EXPERIMENTAL_OCI=1 && echo "${{ secrets.GITHUB_TOKEN }}" | helm registry login -u "${{ github.actor }}" --password-stdin "${{ env.DOCKER_HOSTNAME }}"
- name: Helm chart push
if: ${{ (github.event_name != 'pull_request') && !contains(github.ref, 'tags') }}
run: export HELM_REPOSITORY=ghcr.io/mesh-for-data/arrow-flight-module-chart && make chart-push
run: export HELM_REPOSITORY=ghcr.io/fybrik/arrow-flight-module-chart && make chart-push
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
[![GitHub Actions Build](https://github.com/mesh-for-data/the-mesh-for-data-flight-module/actions/workflows/build.yml/badge.svg)](https://github.com/mesh-for-data/the-mesh-for-data-flight-module/actions/workflows/build.yml)
[![GitHub Actions Build](https://github.com/fybrik/arrow-flight-module/actions/workflows/build.yml/badge.svg)](https://github.com/fybrik/arrow-flight-module/actions/workflows/build.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# arrow-flight-module

The arrow-flight-module (AFM) for [The Mesh for Data](https://github.com/IBM/the-mesh-for-data) brings enforcement of data governance policies to the world of [Apache Arrow](https://arrow.apache.org/)
The arrow-flight-module (AFM) for [Fybrik](https://github.com/fybrik/fybrik) brings enforcement of data governance policies to the world of [Apache Arrow](https://arrow.apache.org/)
[Flight](https://arrow.apache.org/docs/format/Flight.html).

## What is it?

AFM is a flight server Flight server that enables applications to consume tabular data from data sources. More importantly, the AFM is also a Policy Enforcement Point (PEP) capable of performing enforcement actions dictated by a Policy Decision Point.
Such enforcement actions include blocking unauthorized requests, validating and transforming data payloads.

## Register as a Mesh for Data module
## Register as a Fybrik module

To register AFM as a Mesh for Data module apply `module.yaml` to the m4d-system namespace of your cluster.
To register AFM as a Fybrik module apply `module.yaml` to the fybrik-system namespace of your cluster.

To install the latest release run:

```bash
kubectl apply -f https://github.com/mesh-for-data/arrow-flight-module/releases/latest/download/module.yaml -n m4d-system
kubectl apply -f https://github.com/fybrik/arrow-flight-module/releases/latest/download/module.yaml -n fybrik-system
```

### Version compatbility matrix

| Mesh for Data | AFM | Command
| Fybrik | AFM | Command
| --- | --- | ---
| 0.1.x | 0.1.x | `https://github.com/mesh-for-data/arrow-flight-module/releases/download/v0.1.0/module.yaml`
| 0.2.x | 0.2.x | `https://github.com/mesh-for-data/arrow-flight-module/releases/download/v0.2.0/module.yaml`
| master | master | `https://raw.githubusercontent.com/mesh-for-data/arrow-flight-module/master/module.yaml`
| 0.1.x | 0.1.x | `https://github.com/fybrik/arrow-flight-module/releases/download/v0.1.0/module.yaml`
| 0.2.x | 0.2.x | `https://github.com/fybrik/arrow-flight-module/releases/download/v0.2.0/module.yaml`
| master | master | `https://raw.githubusercontent.com/fybrik/arrow-flight-module/master/module.yaml`


## Build and deploy to Kubernetes
Expand Down Expand Up @@ -66,7 +66,7 @@ For example, to use `sample/sample.yaml` as configuration run:
helm upgrade --reuse-values --set-file config_override=sample/sample.yaml afm ./helm/afm
```

It is also possible to specify specific configuration values following the modules specification of The Mesh for Data. Generally, you would want The Mesh for Data to do that for you and not deal with it directly.
It is also possible to specify specific configuration values following the modules specification of Fybrik. Generally, you would want Fybrik to do that for you and not deal with it directly.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions helm/afm/values.sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ read:
connection:
name: s3
s3:
bucket: m4d-test-bucket
bucket: fybrik-test-bucket
endpoint: s3.eu-gb.cloud-object-storage.appdomain.cloud
object_key: test1.parquet
type: 2
Expand All @@ -29,7 +29,7 @@ read:
connection:
name: s3
s3:
bucket: m4d-test-bucket
bucket: fybrik-test-bucket
endpoint: s3.eu-gb.cloud-object-storage.appdomain.cloud
object_key: test2.parquet
type: 2
Expand Down
2 changes: 1 addition & 1 deletion helm/afm/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
replicaCount: 1

image:
repository: ghcr.io/mesh-for-data/arrow-flight-module
repository: ghcr.io/fybrik/arrow-flight-module
tag: latest
pullPolicy: null
pullSecret: null
Expand Down
8 changes: 4 additions & 4 deletions module.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
apiVersion: app.m4d.ibm.com/v1alpha1
kind: M4DModule
apiVersion: app.fybrik.io/v1alpha1
kind: FybrikModule
metadata:
name: arrow-flight-module
labels:
name: arrow-flight-module
version: latest # semantic version
spec:
chart:
name: ghcr.io/mesh-for-data/arrow-flight-module-chart:latest
name: ghcr.io/fybrik/arrow-flight-module-chart:latest
values:
image.tag: latest
flows:
Expand All @@ -17,7 +17,7 @@ spec:
endpoint:
port: 80
scheme: grpc
protocol: m4d-arrow-flight
protocol: fybrik-arrow-flight
dataformat: arrow
supportedInterfaces:
- flow: read
Expand Down

0 comments on commit b472f4f

Please sign in to comment.