Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
t83714 committed Oct 31, 2022
1 parent a517b0d commit b97d854
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 34 deletions.
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,23 @@

Magda CSW Connector is created for crawling data from [CSW(Catalog Service for the Web)](https://en.wikipedia.org/wiki/Catalogue_Service_for_the_Web) data source.

### Helm Chart
### Release Registry

It's recommanded to deploy connectors with as [dependencies](https://helm.sh/docs/topics/chart_best_practices/dependencies/) of a Magda helm deployment. Example can be found from [here](https://github.com/magda-io/magda-config).
Since v2.0.0, we use [Github Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) as our official Helm Chart & Docker Image release registry.

- Magda Helm Charts Repository Url: https://charts.magda.io
It's recommended to deploy connectors with as [dependencies](https://helm.sh/docs/topics/chart_best_practices/dependencies/) of a Magda helm deployment.

The [helm chart](https://helm.sh/docs/topics/charts/) for this connector is auto released when a [Github Release](https://help.github.com/en/github/administering-a-repository/creating-releases) is created for this repo.

- Add repository to helm:

```bash
helm repo add magda-io https://charts.magda.io
```yaml
dependencies:
- name: magda-csw-connector
version: "2.0.0"
alias: connector-xxx
repository: "oci://ghcr.io/magda-io/charts"
tags:
- connectors
- connector-xxx
```
### Docker Image

Docker image releases can be found from Docker Hub:

https://hub.docker.com/r/data61/magda-csw-connector/

Development releases (per commit) are also available from [GitHub Registry](https://github.com/magda-io/magda-csw-connector/packages) and accessible with access token.

## Requirements
Kubernetes: `>= 1.21.0`
Expand Down
29 changes: 12 additions & 17 deletions README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,23 @@

Magda CSW Connector is created for crawling data from [CSW(Catalog Service for the Web)](https://en.wikipedia.org/wiki/Catalogue_Service_for_the_Web) data source.

### Helm Chart
### Release Registry

It's recommanded to deploy connectors with as [dependencies](https://helm.sh/docs/topics/chart_best_practices/dependencies/) of a Magda helm deployment. Example can be found from [here](https://github.com/magda-io/magda-config).
Since v2.0.0, we use [Github Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) as our official Helm Chart & Docker Image release registry.

- Magda Helm Charts Repository Url: https://charts.magda.io
It's recommended to deploy connectors with as [dependencies](https://helm.sh/docs/topics/chart_best_practices/dependencies/) of a Magda helm deployment.

The [helm chart](https://helm.sh/docs/topics/charts/) for this connector is auto released when a [Github Release](https://help.github.com/en/github/administering-a-repository/creating-releases) is created for this repo.

- Add repository to helm:

```bash
helm repo add magda-io https://charts.magda.io
```yaml
dependencies:
- name: magda-csw-connector
version: "2.0.0"
alias: connector-xxx
repository: "oci://ghcr.io/magda-io/charts"
tags:
- connectors
- connector-xxx
```

### Docker Image

Docker image releases can be found from Docker Hub:

https://hub.docker.com/r/data61/magda-csw-connector/

Development releases (per commit) are also available from [GitHub Registry](https://github.com/magda-io/magda-csw-connector/packages) and accessible with access token.

{{ template "chart.maintainersSection" . }}

{{ template "chart.requirementsSection" . }}
Expand Down

0 comments on commit b97d854

Please sign in to comment.