Skip to content

Commit

Permalink
Improve blog feature
Browse files Browse the repository at this point in the history
Includes author name and description.
  • Loading branch information
michaelfitzo committed Nov 8, 2024
1 parent 7a92a10 commit b388690
Show file tree
Hide file tree
Showing 7 changed files with 116 additions and 12 deletions.
5 changes: 2 additions & 3 deletions gen3/docs/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
authors:
qureshi:
name: Jawad Qureshi
description: Lead Platform Engineer
description: Lead Platform Engineer, CTDS
avatar: https://github.com/jawadqur.png
elise:
name: Elise Castle
description: Platform Engineer - Gen3
url: https://github.com/EliseCastle23
description: Platform Engineer, CTDS
avatar: https://github.com/EliseCastle23.png
1 change: 1 addition & 0 deletions gen3/docs/blog/posts/gen3-laptop.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ date: 2023-09-13
slug: Gen3 on laptop
categories:
- Operator
- CTDS
tags:
- Kubernetes
- Minikube
Expand Down
17 changes: 8 additions & 9 deletions gen3/docs/blog/posts/gen3-observability.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
---
draft: false
slug: Observability
title: "Observability"
slug: observability
authors:
- elise
date: 2024-10-15
categories:
- Operator
- CTDS
tags:
- Observability
- Helm Chart
Expand All @@ -14,17 +18,14 @@ tags:
- Real User Monitoring (RUM)
- Metrics
- Log Aggregation
- Kubernetes
- Dashboards
- Kubernetes Monitoring
- Time-Series Database
- Alerting
- Frontend Monitoring
- Grafana Dashboards
- Open Source Monitoring
date: 2024-10-15
categories:
- Operator

---

# Deploying a Comprehensive Observability Stack with Helm
Expand All @@ -44,9 +45,7 @@ A log aggregation system designed to index and query logs with minimal resource

In this setup, Loki and Mimir are configured with internal ingress resources, enabling Alloy to send metrics and logs securely via VPC peering connections. Both Loki and Mimir write the ingested data to Amazon S3 for scalable and durable storage. This data can be queried and visualized through Grafana, which is hosted behind an internet-facing ingress. Access to Grafana can be restricted using CIDR ranges defined through the ALB ingress annotation: alb.ingress.kubernetes.io/inbound-cidrs: "cidrs". Additionally, the chart supports SAML authentication for Grafana, configured through the grafana.ini field, ensuring secure user access.

<p align="center">
<img src="Grafana.png" alt="Grafana Architecture" />
</p>
![Grafana architecutre](Grafana.png)


### Fips compliant images
Expand Down
1 change: 1 addition & 0 deletions gen3/docs/blog/posts/k8s-for-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors:
date: 2023-08-13
categories:
- Operator
- CTDS
slug: k8s for development
tags:
- Kubernetes
Expand Down
1 change: 1 addition & 0 deletions gen3/docs/blog/posts/k8s-productivity-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ date: 2023-10-13
slug: k8s tools
categories:
- Operator
- CTDS
tags:
- Kubernetes
- Minikube
Expand Down
2 changes: 2 additions & 0 deletions gen3/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ theme:
name: material
features:
- navigation.footer
custom_dir: overrides

palette:

Expand Down Expand Up @@ -145,6 +146,7 @@ plugins:
- tags
- blog:
enabled: true
authors: true
authors_file: blog/authors.yml
blog_dir: blog
blog_toc: true
Expand Down
101 changes: 101 additions & 0 deletions gen3/overrides/partials/post.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<!--
Copyright (c) 2016-2023 Martin Donath <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
-->

<!-- Post excerpt -->
<article class="md-post md-post--excerpt">
<header class="md-post__header">

<!-- Post authors -->
{% if post.authors %}
<nav class="md-post__authors md-typeset">
{% for author in post.authors %}
<span class="md-author">
<img src="{{ author.avatar }}" alt="{{ author.name }}" />
</span>
<p> {{ author.name }}, </p>
<p> {{ author.description }} </p>
{% endfor %}
</nav>
{% endif %}

<!-- Post metadata -->
<div class="md-post__meta md-meta">
<ul class="md-meta__list">

<!-- Post date -->
<li class="md-meta__item">
<time datetime="{{ post.config.date.created }}">
{{- post.config.date.created | date -}}
</time>
{#- Collapse whitespace -#}
</li>

<!-- Post categories -->
{% if post.categories %}
<li class="md-meta__item">
{{ lang.t("blog.categories.in") }}
{% for category in post.categories %}
<a
href="{{ category.url | url }}"
class="md-meta__link"
>
{{- category.title -}}
</a>
{%- if loop.revindex > 1 %}, {% endif -%}
{% endfor -%}
</li>
{% endif %}

<!-- Post readtime -->
{% if post.config.readtime %}
{% set time = post.config.readtime %}
<li class="md-meta__item">
{% if time == 1 %}
{{ lang.t("readtime.one") }}
{% else %}
{{ lang.t("readtime.other") | replace("#", time) }}
{% endif %}
</li>
{% endif %}
</ul>

<!-- Draft marker -->
{% if post.config.draft %}
<span class="md-draft">
{{ lang.t("blog.draft") }}
</span>
{% endif %}
</div>
</header>

<!-- Post content -->
<div class="md-post__content md-typeset">
{{ post.content }}

<!-- Continue reading link -->
<nav class="md-post__action">
<a href="{{ post.url | url }}">
{{ lang.t("blog.continue") }}
</a>
</nav>
</div>
</article>

0 comments on commit b388690

Please sign in to comment.