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.

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

portal documentation updates for shared zones #486

Merged
merged 4 commits into from
Apr 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions modules/docs/src/main/resources/microsite/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,7 @@
background: url("../img/jumbotron_pattern.png") repeat center;
background-color: #123051;
}

.important {
color: red;
}
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/docs/src/main/tut/img/portal/batch-change-list.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/docs/src/main/tut/img/portal/batch-change-new.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/docs/src/main/tut/img/portal/batch-change-summary.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 12 additions & 3 deletions modules/docs/src/main/tut/portal/batch-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,24 @@ Batch change is an alternative to submitting individual RecordSet changes and pr
* The ability to include records of multiple record types across multiple zones.
* Input names are entered as fully-qualified domain names (or IP addresses for **PTR** records), so users don't have to think in record/zone context.

To update an existing record, you must delete the record first and add all expected records within the same batch; a delete and add of the same recordset within a batch change request will be processed as an update.
#### Access
* Access permissions will follow existing rules (admin group or ACL access). Note that an update (delete and add of the same record name, zone and record type combination) requires **Write** or **Delete** access.
* <span class="important">**NEW**</span> **Records in shared zones.** All users are permitted to create new records or update unowned records in shared zones.

Batch changes are also susceptible to the following restrictions:
#### Supported record types
* Current supported record types for batch change are: **A**, **AAAA**, **CNAME**, **PTR**, **TXT**, and **MX**.
* Additionally, there are **A+PTR** and **AAAA+PTR** types that will be processed as separate A (or AAAA) and PTR changes in the VinylDNS backend. Deletes for **A+PTR** and **AAAA+PTR** require Input Name and Record Data.
* Supported record types for records in shared zones may vary.
Contact your VinylDNS administrators to find the allowed record types.
This does not apply to zone administrators or users with specific ACL access rules.

#### Requirements
* Batch change requests must contain at least one change.
* The maximum number of single changes within a batch change varies by instance of VinylDNS. Contact your VinylDNS administrators to find the batch change limit for your instance.
* Access permissions will follow existing rules (admin group or ACL access). Note that an update (delete and add of the same record name, zone and record type combination) requires **Write** access.
* To update an existing record, you must delete the record first and add all expected records within the same batch; a delete and add of the same recordset within a batch change request will be processed as an update.
* When creating a new record in a shared zone, or updating an existing unowned record, a record owner group is required. Once the owner group is assigned only users in that group, zone admins, and users with ACL permissions can modify the record.

---
### Create a Batch Change
1. Go to the Batch Changes section of the site.
1. Select the *New Batch Change* button.
Expand Down
2 changes: 1 addition & 1 deletion modules/docs/src/main/tut/portal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In order to use [tooling](/tools) to access VinylDNS, all users must download th
[Learn more](credentials)

### Zones
The Zones section of the portal is for managing DNS zones and records. This area also includes more granular management of user abilities. To access Zones in the portal select the Zones link in the left column navigation.
The Zones section of the portal is for managing DNS zones and records. This area also includes more granular management of user abilities. To access Zones in the portal select the Zones link in the left column navigation. Access to zones in this part of the portal is limited to zone administrators and users with explicit permissions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe users that have been granted access instead of users with explicit permissions.


[Learn More](zones)

Expand Down
3 changes: 3 additions & 0 deletions modules/docs/src/main/tut/portal/manage-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,6 @@ If you don't want a user to have full access to a zone you can use ACL rules to
1. Submit the form

[![ACL rule form screenshot](../img/portal/create-acl-rule.png){:.screenshot}](../img/portal/create-acl-rule.png)

### <span class="important">**NEW**</span> Shared Zones
The shared zone feature is designed to allow more granular record ownership and management in a flexible way. Super users can mark zones as 'shared' which then allow any users to create new records or claim existing unowned records in zones. Zone administrators can assign records in a shared zone to specific groups by designating a group when creating the record set or when updating existing records in the portal. Users who are not zone administrators can create new records in shared zones, or claim and modify unowned records in shared zones, through the [Batch Change](batch-changes) interface.
10 changes: 8 additions & 2 deletions modules/docs/src/main/tut/portal/manage-records.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@ title: "Manage Records"
section: "portal_menu"
---
## Manage Records <a id="managingRecords"></a>
There are currently two ways to manage records in the VinylDNS portal. This covers managing individual records through their associated zone. To manage multiple records, possibly across zones, you can use the [Batch Change](batch-changes) area of the portal.
There are currently two ways to manage records in the VinylDNS portal. This covers managing individual records through their associated zone. To manage multiple records at once, possibly across zones, and records in shared zones you can use the [Batch Change](batch-changes) area of the portal.

Current supported record types in Zones are: **A**, **AAAA**, **CNAME**, **MX**, **PTR**, **NS**, **TXT**, **SPF**, **SRV**, and **SSHFP**.
#### Access
Only zone administrators and users with ACL rules can manage records this way.

#### Supported record types
A, AAAA, CNAME, MX, NS, PTR, SPF, SRV, SSHFP, and TXT

---

To manage records in a zone go to the *Zones* section of the portal and select the *View* button that corresponds with the zone you want to manage. The *Manage Records* tab will be the active tab by default. Once you are in the *Manage Records* tab of the zone, you can create new records sets or update or delete existing record sets.

Expand Down
2 changes: 1 addition & 1 deletion modules/docs/src/main/tut/portal/zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ section: "portal_menu"

## Zones

Zones is the core area of the VinylDNS portal. All zones you have access to are found here along with their records and change history.
Zones is the core area of the VinylDNS portal. All zones you have access to are found here along with their records and change history. **Note** you may have access to specific records in shared zones, in which case you will not see those zones in this area. Those records are accessible via the [Batch Change](batch-changes) area of the portal.

* [Connect to your zone](connect-to-zone)
* [Manage records](manage-records)
Expand Down