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

Jump to bottom

Updated docs for cluster metadata map #22

Merged
merged 5 commits into from
Jun 10, 2019
Merged

Updated docs for cluster metadata map #22

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
22ec86a
Updated docs for cluster metadate map
jpapejr May 28, 2019
8815a35
updates to make the build god happy
jpapejr May 28, 2019
7f4847c
and one more. ;/
jpapejr May 28, 2019
36144a6
restructured into an optional step 5
jpapejr May 31, 2019
1e31295
Typo corrections
Jun 10, 2019
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,25 @@ With Watch Keeper set up in your cluster, you can retrieve deployment informatio
2. Click **Sign in with GitHub**.
3. Find the GitHub organization that you connected RazeeDash to and click **Launch** to open the RazeeDash console.

5. OPTIONAL: As you'll notice in the Razee dashboard, clusters you have configured to be watched and reported on are listed using a long ID token like `8e13917c-7e6b-11e9-a7d0-9e237586b5f9`. Razee can be configured to display the clusters using a more human-readable value versus the IDs by creating a ConfigMap in your target cluster and labelling it with `razee/cluster-metadata=true`.

For example:

```
apiVersion: v1
data:
name: razee-1
kind: ConfigMap
metadata:
labels:
razee/cluster-metadata: "true"
razee/watch-resource: debug
name: razee1-cluster-metadata
namespace: default
````

After the ConfigMap is picked up (within a few moments), Razee will diplay this cluster on the dashboard using `razee-1` instead of the long ID value seen before. Note that it may take up to 2 minutes before the change can be seen in the dashboard.
Copy link
Member

Choose a reason for hiding this comment

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

typo: diplay

Copy link
Member

Choose a reason for hiding this comment

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

and it should only take up to 1 minute before change can be seen


## Step 3: Automatically deploy Kubernetes resources with RemoteResources

RemoteResource and RemoteResourceS3 are Kapitan components that you can use to automatically deploy Kubernetes resources that are stored in a source repository. Simply define the source repository in your remote resource and create the remote resource in your cluster. The remote resource controller automatically connects to your source repository, downloads the Kubernetes configuration file, and applies the file to your cluster. This process repeats about every two minutes. All you have to do is to keep your source file up-to-date and let your cluster auto-deploy it.
Expand Down