Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First take at READMEs #86

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

First take at READMEs #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 14 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,21 @@
[![CharmHub Badge](https://charmhub.io/bind/badge.svg)](https://charmhub.io/bind)
[![Publish to edge](https://github.com/canonical/bind-operator/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/bind-operator/actions/workflows/publish_charm.yaml)
[![Promote charm](https://github.com/canonical/bind-operator/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/bind-operator/actions/workflows/promote_charm.yaml)
[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io)
# DNS charms

Check failure on line 1 in README.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'DNS charms' should use sentence-style capitalisation.

Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'DNS charms' should use sentence-style capitalisation.", "location": {"path": "README.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

# Bind Operator
This repository contains the code for all the DNS charms:
1. `bind`: A machine charm managing a bind instance configured as a primary DNS server. See the [bind README](bind-operator/README.md) for more information.
2. `dns-policy`: A subordinate charm that adds a policy layer in front of the bind charm. See the [dns-policy README](dns-policy-operator/README.md) for more information.
3. `dns-integrator`: An integrator charm that allows the creation of record request through its configuration. See the [dns-integrator README](dns-integrator-operator/README.md) for more information.

A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators)
deploying and managing a DNS server Integrator on bare metal.

This charm simplifies configuration of a DNS server client by providing a single point
of configuration for all the requirers using the same DNS server. It can be
deployed on virtual machines or bare metal.

As such, the charm makes it easy to manage and propagate DNS configuration, while
giving the freedom to deploy on the substrate of their choice.

For DevOps or SRE teams this charm will make operating any charm requiring dynamic DNS
configuration simple and straightforward through Juju's clean interface.
It also contains the snapped workload of some charms:
1. `charmed-bind`: A snapped bind specifically made for the bind charm. See the [charmed-bind README](charmed-bind/README.md) for more information.
2. `charmed-dns-policy`: A snapped django application specifically made for the dns-policy charm. See the [charmed-dns-policy README](charmed-dns-policy/README.md) for more information.

## Project and community

The Bind Operator is a member of the Ubuntu family. It's an open source
project that warmly welcomes community projects, contributions, suggestions,
fixes and constructive feedback.
The DNS charms project is a member of the Ubuntu family. It is an
open source project that warmly welcomes community projects, contributions,
suggestions, fixes and constructive feedback.

* [Code of conduct](https://ubuntu.com/community/code-of-conduct)
* [Get support](https://discourse.charmhub.io/)
* [Join our online chat](https://chat.charmhub.io/charmhub/channels/charm-dev)
* [Contribute](https://charmhub.io/bind/docs/how-to-contribute)
Thinking about using the Bind Operator for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!

## Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://charmhub.io/bind/docs) to enable easy collaboration. Please use the "Help us improve this documentation" links on each documentation page to either directly change something you see that's wrong, ask a question, or make a suggestion about a potential change via the comments section.

If there's a particular area of documentation that you'd like to see that's missing, please [file a bug](https://github.com/canonical/bind-operator/issues).

---

For further details,
[see the charm's detailed documentation](https://charmhub.io/bind/docs).
* [Issues](https://github.com/canonical/dns-charms/issues)
* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
43 changes: 43 additions & 0 deletions bind-operator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[![CharmHub Badge](https://charmhub.io/bind/badge.svg)](https://charmhub.io/bind)
[![Publish to edge](https://github.com/canonical/dns-charms/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/dns-charms/actions/workflows/publish_charm.yaml)
[![Promote charm](https://github.com/canonical/dns-charms/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/dns-charms/actions/workflows/promote_charm.yaml)
[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io)

# Bind Operator

Check failure on line 6 in bind-operator/README.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Bind Operator' should use sentence-style capitalisation.

Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Bind Operator' should use sentence-style capitalisation.", "location": {"path": "bind-operator/README.md", "range": {"start": {"line": 6, "column": 3}}}, "severity": "ERROR"}

A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators)
deploying and managing a DNS server on bare metal.

This charm simplifies configuration of a DNS server by providing a single point
of configuration for all the requirers using the same DNS server. It can be
deployed on virtual machines or bare metal.

As such, the charm makes it easy to manage and propagate DNS configuration, while
giving the freedom to deploy on the substrate of their choice.

For DevOps or SRE teams this charm will make operating any charm requiring dynamic DNS
configuration simple and straightforward through Juju's clean interface.

## Get started

The charm can be deployed to any machine model by pulling it from [charmhub](https://charmhub.io/bind):
```
juju deploy bind --channel=latest/edge
```

You can then integrate it with any charm supporting the requirer side of the `dns_record` interface and the bind operator will
start serving those DNS records.

### Basic operations

No actions are available as this charm is meant to be operated through its integrations.
It can integrate with any requirer charm implementing the [dns_record interface](https://canonical.github.io/charm-relation-interfaces/interfaces/dns_record/v0/).

## Learn more
* [Read more](https://charmhub.io/bind/docs)
* [Official webpage](https://charmhub.io/bind)

## Project and community
* [Issues](https://github.com/canonical/dns-charms/issues)
* [Contributing](https://charmhub.io/bind/docs/how-to-contribute)
* [Matrix](https://chat.charmhub.io/charmhub/channels/charm-dev)
23 changes: 17 additions & 6 deletions charmed-bind/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,40 @@
# Bind Snap

This snap is meant to be the workload of the [bind-operator](https://github.com/canonical/bind-operator) charm.
This snap is meant to be the workload of the [bind-operator](https://github.com/canonical/dns-charms/bind-operator) charm.

## Installing the Snap
## Get started

Check warning on line 5 in charmed-bind/README.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.

Raw Output:
{"message": "[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.", "location": {"path": "charmed-bind/README.md", "range": {"start": {"line": 5, "column": 1}}}, "severity": "WARNING"}

### Installing the Snap

Check failure on line 7 in charmed-bind/README.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Installing the Snap' should use sentence-style capitalisation.

Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Installing the Snap' should use sentence-style capitalisation.", "location": {"path": "charmed-bind/README.md", "range": {"start": {"line": 7, "column": 5}}}, "severity": "ERROR"}
The snap can be installed directly from the Snap Store. Follow the link below for more information.

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/charmed-bind)


## Building the Snap
### Building the Snap

Check failure on line 13 in charmed-bind/README.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Building the Snap' should use sentence-style capitalisation.

Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Building the Snap' should use sentence-style capitalisation.", "location": {"path": "charmed-bind/README.md", "range": {"start": {"line": 13, "column": 5}}}, "severity": "ERROR"}
The steps outlined below are based on the assumption that you are building the snap with the latest LTS of Ubuntu. If you are using another version of Ubuntu or another operating system, the process may be different.

### Clone Repository
#### Clone Repository

Check failure on line 16 in charmed-bind/README.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Clone Repository' should use sentence-style capitalisation.

Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Clone Repository' should use sentence-style capitalisation.", "location": {"path": "charmed-bind/README.md", "range": {"start": {"line": 16, "column": 6}}}, "severity": "ERROR"}
```bash
git clone [email protected]:canonical/charmed-bind.git
cd charmed-bind
```
### Installing and Configuring Prerequisites
#### Installing and Configuring Prerequisites

Check failure on line 21 in charmed-bind/README.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Installing and Configuring Prerequisites' should use sentence-style capitalisation.

Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Installing and Configuring Prerequisites' should use sentence-style capitalisation.", "location": {"path": "charmed-bind/README.md", "range": {"start": {"line": 21, "column": 6}}}, "severity": "ERROR"}
```bash
sudo snap install snapcraft
sudo snap install lxd
sudo lxd init --auto
```
### Packing and Installing the Snap
#### Packing and Installing the Snap
```bash
snapcraft pack
sudo snap install ./charmed-bind_*.snap --devmode
```

## Learn more
* [Read more](https://charmhub.io/bind/docs)
* [Official webpage](https://charmhub.io/bind)

## Project and community
* [Issues](https://github.com/canonical/dns-charms/issues)
* [Contributing](https://charmhub.io/bind/docs/how-to-contribute)
* [Matrix](https://chat.charmhub.io/charmhub/channels/charm-dev)
Loading