Skip to content

Commit

Permalink
#19 Add info on aws instance tags. (#31)
Browse files Browse the repository at this point in the history
Add information on recent features.
Includes:
- Added info on instance tags
- AWS backup/restore page.
  • Loading branch information
bbaddepudi committed Mar 12, 2019
1 parent 6095cfa commit 7620ac7
Show file tree
Hide file tree
Showing 9 changed files with 92 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/content/latest/manage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ menu:
<a class="section-link icon-offset" href="enterprise-edition/">
<div class="head">
<img class="icon" src="/images/section_icons/manage/enterprise.png" aria-hidden="true" />
<div class="articles">10 articles</div>
<div class="articles">11 articles</div>
<div class="title">Enterprise Edition</div>
</div>
<div class="body">
Expand Down
12 changes: 12 additions & 0 deletions docs/content/latest/manage/enterprise-edition/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,18 @@ YugaByte DB creates a `universe` with a bunch of instances (VMs, pods, machines
</a>
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="instance-tags/">
<div class="head">
<img class="icon" src="/images/section_icons/manage/enterprise/edit_flags.png" aria-hidden="true" />
<div class="title">Instance Tags</div>
</div>
<div class="body">
Create and Edit Instance tags.
</div>
</a>
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="cluster-health/">
<div class="head">
Expand Down
16 changes: 13 additions & 3 deletions docs/content/latest/manage/enterprise-edition/backup-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ Wait for the universe to become ready.

## Setting Storage for Backup

### Local Storage
In this example, we create a local directory on the tserver to backup to. Select the
`Connect` modal in the `Nodes` tab of the universe and select the server from Admin Host.
`Connect` modal in the `Nodes` tab of the universe and select the server from Admin Host.

![Connect Modal](/images/ee/br-connect-modal.png)

Expand All @@ -38,6 +39,14 @@ $ sudo mkdir /backup; sudo chown yugabyte /backup
Note that when there are more than 1 nodes, an nfs mounted on each server is recommended, and
creating a local backup folder on each server will not work.

### AWS Cloud Storage
One can also backup to Amazon cloud using the `amazone S3` tab in Backup configuration.

![AWS Backup](/images/ee/br-aws-s3.png)

The Access Key & Secret text can be added for the IAM of the user. The destination S3 Bucket where backups are
stored can be entered in the format shown in the sample above.

## Backup

Now, select `Configuration` on the left panel, select the `Backup` tab on top, click `NFS` and enter
Expand All @@ -46,9 +55,10 @@ Now, select `Configuration` on the left panel, select the `Backup` tab on top, c
![Cloud Provider Configuration](/images/ee/cloud-provider-configuration.png)

Now, go to the `Backups` tab. There, click on `Create Backup`. A modal should appear where you can
enter the table (this demo uses the default redis table) and NFS Storage option.
enter the table (this demo uses the default redis table) and NFS Storage option. If S3 was selected
as the storage, the "S3 Storage" dropdown option can be chosen during this backup creation.

![Backup Modal](/images/ee/create-backup-modal.png)
![Backup Modal](/images/ee/br-aws-s3.png)

Select `OK`. If you refresh the page, you'll eventually see a completed task.

Expand Down
66 changes: 66 additions & 0 deletions docs/content/latest/manage/enterprise-edition/instance-tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: Create/Edit Instance Tags
linkTitle: Create/Edit Instance Tags
description: Create/Edit Instance Tags
aliases:
- /manage/enterprise-edition/instance-tags/
menu:
latest:
identifier: manage-instance-tags
parent: manage-enterprise-edition
weight: 742
isTocNested: true
showAsideToc: true
---

The instances created on a cloud provider can be assigned special metadata to help manage, bill or audit the resources. On AWS they referred to as
[instance tags](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html). We provide a way to create and edit these from the
YugaWare universe dashboard.

{{< note title="Note" >}}
We provide this option to set instance tags for AWS cloud provider only currently.
{{< /note >}}

## 1. Create Instance Tags
During the universe creation step, with an AWS cloud provider, YugaWare will provide the option to input the instance tags as a map of keys/values as shown below.

![Create Instance Tags](/images/ee/inst-tags-1.png)

User can provide these key/values in any order.

### Templated Tags
`Name` is the only key that can have `templated` tags, so it can be made of different parts filled in at run-time to determine node and instance names.

- The parts of the template should be enclosed between `${` and `}`.
- The reserved keywords that can be specified: `universe`, `instance-id`, `zone`, and `region`.
- Templated tag value needs to have `instance-id` at the minimum.
- Order of the parts of template do not matter.

*Check Cloud Provider instances*

Browse to the cloud provider's instances page. In this example, since we are using AWS as the cloud provider, browse to `EC2` -> `Running Instances`
in the correct availability zone and search for instances that have `test-tags` in their name. You should see something as follows in the
`Tags` tab of those instances.

![Instances with tags](/images/ee/inst-tags-aws-1.png)

{{< note title="Note" >}}
`yb-server-type` and `launched-by` are internally reserved key names.
{{< /note >}}

## 2. Edit Instance Tags

The map of instance tags can be changed using the edit universe operation. One can modify, insert or delete existing instance tags as shown below:

![Edit Instance Tags](/images/ee/inst-tags-2.png)

These are changes, compared to the input during the create universe:

- `Billing` was modified.
- `MyInfo` was deleted.
- `NewInfo` was added.
- `Department` was not changed in any way.
Note that `Name` key field cannot be edited in any form.

As before, one can confirm on the cloud provider list of instances that the tags have been updated correctly:
![Edited instances with tags](/images/ee/inst-tags-aws-2.png)
Binary file added docs/static/images/ee/br-aws-s3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/ee/inst-tags-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/ee/inst-tags-2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/ee/inst-tags-aws-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/ee/inst-tags-aws-2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7620ac7

Please sign in to comment.