Skip to content

Commit

Permalink
Update README/metadata/CONTRIBUTING (#121)
Browse files Browse the repository at this point in the history
taurus-forever authored Apr 21, 2023

Verified

This commit was signed with the committer’s verified signature.
WebFreak001 Jan Jurzitza
1 parent 3f7d38c commit c2b7bb7
Showing 3 changed files with 27 additions and 11 deletions.
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ this operator.
- All enhancements require review before being merged. Code review typically examines
- code quality
- test coverage
- user experience for Juju administrators this charm.
- user experience for Juju administrators of this charm.
- Please help us out in ensuring easy to review branches by rebasing your pull request branch onto
the `main` branch. This also avoids merge commits and creates a linear Git commit history.

@@ -38,7 +38,6 @@ tox run -e integration # integration tests
tox # runs 'lint' and 'unit' environments
```


## Build charm

Build the charm in this git repository using:
@@ -52,8 +51,16 @@ charmcraft pack
```bash
# Create a model
juju add-model dev

# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"

# Deploy the charm
juju deploy ./postgresql_ubuntu-22.04-amd64.charm
```
```

## Canonical Contributor Agreement

Canonical welcomes contributions to the PostgreSQL Operator. Please check out our
[contributor agreement](https://ubuntu.com/legal/contributors)if you're
interested in contributing to the solution.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Charmed PostgreSQL Operator
# Charmed PostgreSQL VM Operator

## Description

23 changes: 16 additions & 7 deletions metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Copyright 2021 Canonical Ltd.
# Copyright 2023 Canonical Ltd.
# See LICENSE file for licensing details.

name: postgresql
display-name: Charmed PostgreSQL VM
summary: Charmed PostgreSQL VM operator
description: |
Charm to operate the PostgreSQL database on machines
Charm to operate the PostgreSQL database on machines.
docs: https://discourse.charmhub.io/t/charmed-postgresql-documentation/9710
summary: |
Charm to operate the PostgreSQL database on machines
series:
- jammy
source: https://github.com/canonical/postgresql-operator
issues: https://github.com/canonical/postgresql-operator/issues
website:
- https://ubuntu.com/data/postgresql
- https://charmhub.io/postgresql
- https://github.com/canonical/postgresql-operator
- https://chat.charmhub.io/charmhub/channels/data-platform

peers:
database-peers:
@@ -29,11 +33,16 @@ requires:
certificates:
interface: tls-certificates
limit: 1
optional: true
s3-parameters:
interface: s3
limit: 1
optional: true

storage:
pgdata:
type: filesystem
location: /var/snap/charmed-postgresql/common

assumes:
- juju

0 comments on commit c2b7bb7

Please sign in to comment.