Skip to content

Commit

Permalink
Merge pull request #21 from klaytn/rebranding
Browse files Browse the repository at this point in the history
rebranding
  • Loading branch information
jaeeuncho34 authored Nov 8, 2024
2 parents 4a37620 + 43124e1 commit 9494f45
Show file tree
Hide file tree
Showing 35 changed files with 202 additions and 252 deletions.
88 changes: 66 additions & 22 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,76 @@
name: github pages
# Sample workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- main # Set a branch to deploy
pull_request:
- main

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

# Default to bash
defaults:
run:
shell: bash

jobs:
deploy:
runs-on: ubuntu-20.04
# Build job
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.137.1
steps:
- uses: actions/checkout@v2
- name: Install Hugo CLI
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Checkout
uses: actions/checkout@v4
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
submodules: recursive
fetch-depth: 0
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Install Node.js dependencies
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
- name: Build with Hugo
env:
HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
HUGO_ENVIRONMENT: production
TZ: America/Los_Angeles
run: |
hugo \
--gc \
--minify \
--baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
hugo-version: 'latest'
# extended: true

- name: Build
run: hugo --environment gh-pages
path: ./public

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
6 changes: 3 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "themes/hugo-theme-learn"]
path = themes/hugo-theme-learn
url = https://github.com/matcornic/hugo-theme-learn.git
[submodule "themes/hugo-theme-relearn"]
path = themes/hugo-theme-relearn
url = https://github.com/McShelby/hugo-theme-relearn.git
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Klaytn Workshop - Baobab Setup
# Kaia Workshop - Kairos Setup

![Klaytn Docs](images/klaytn.png)
![Kaia Docs](/images/Kaia-docs.png)

## Index
- [Overview](#overview)
Expand All @@ -13,10 +13,10 @@

## Overview
<!-- Write Overview about this project -->
**If you want to join Klaytn Baobab network, this workshop will be the best guidance. Below are included in this workshop.**
**If you want to join Kaia Kairos network, this workshop will be the best guidance. Below are included in this workshop.**
- Prerequisites (Firewall & Package Installation)
- Chaindata Fast sync with Baobab
- Baobab Network Configuration
- Chaindata Fast sync with Kairos
- Kairos Network Configuration
- Service Status Management

## How this repository works
Expand All @@ -30,20 +30,21 @@

## Contributing
<!-- Write the way to contribute -->
Thank you for your interest in contributing to Klaytn Workshop. Klaytn Workshop is always open to anyone and we welcome your contribution.
### How to contribute on Klaytn Workshop
Thank you for your interest in contributing to Kaia Workshop. Kaia Workshop is always open to anyone and we welcome your contribution.
### How to contribute on Kaia Workshop
1. Site scaffolding
```
.
├── README.md
├── archetypes
├── config
├── assets
├── content ====> Where contents can be updated.(Markdown)
├── data
├── layouts
├── resources
├── static
└── themes
├── themes
└── hugo.toml
```
2. Labaeling - [issue|typo|update|new]
3. Branch Naming when PR - hubo/update-3-b, hugo/new-3-c
20 changes: 10 additions & 10 deletions static/css/theme-klaytn.css → assets/css/theme-kaia.css
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
--MAIN-LINK-color:#1C90F3; /* Color of links */
--MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */
--MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */
--MAIN-ANCHOR-color: #4CE275; /* color of anchors on titles */

--MENU-HEADER-BG-color:#000000; /* Background color of menu header */
--MENU-HEADER-BG-color:#040404; /* Background color of menu header */
--MENU-HEADER-BORDER-color:#202020; /*Color of menu header border */

--MENU-SEARCH-BG-color:#202020; /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BOX-color: #cc0000; /* Override search field border color */
--MENU-SEARCH-BOX-ICONS-color: #cc0000; /* Override search field icons color */
--MENU-SEARCH-BOX-color: #BFF009; /* Override search field border color */
--MENU-SEARCH-BOX-ICONS-color: #BFF009; /* Override search field icons color */

--MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */
--MENU-SECTIONS-BG-color:#000000; /* Background color of other sections */
--MENU-SECTIONS-ACTIVE-BG-color:#144625; /* Background color of the active section and its childs */
--MENU-SECTIONS-BG-color:#040404; /* Background color of other sections */
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
--MENU-SECTION-ACTIVE-CATEGORY-color: #ccc; /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #5f7707; /* Color of background for the active category (only) */

--MENU-VISITED-color: #cc0000; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #20272b; /* Color of <hr> separator in menu */
--MENU-VISITED-color: #BFF009; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #144625; /* Color of <hr> separator in menu */

}

Expand Down
76 changes: 0 additions & 76 deletions config/gh-pages/config.toml

This file was deleted.

12 changes: 6 additions & 6 deletions content/10_prerequisites/10_firewall_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,35 @@ draft: false
---
{{< line_break >}}

#### 1. *(Only for CN)* Firewall configuration
##### 1. *(Only for CN)* Firewall configuration

##### 1) If pre-cypress performance test is completed, remove below Klaytn CN's IP address of Pre-cypress from your firewall ingress rule.
###### 1) If Private Network performance test is completed, remove below Kaia CN's IP address of Private Network from your firewall ingress rule.
```Pre Cyprss KF CN IP```
```Pre Cyprss KF BN IP```

##### 2) For communication and multichannel between Kairos CN, allow TCP ```32323-32324``` with below IP addresses to your firewall ingress rule.
###### 2) For communication and multichannel between Kairos CN, allow TCP ```32323-32324``` with below IP addresses to your firewall ingress rule.
```54.180.180.202```
```54.180.18.176```
```52.79.134.72```
```52.78.232.39```
```13.124.59.131```

##### 3) Additionally, it is required to allow UDP ``` 32323 ``` with the same IP addresses to your firewall ingress rule.
###### 3) Additionally, it is required to allow UDP ``` 32323 ``` with the same IP addresses to your firewall ingress rule.
```54.180.180.202```
```54.180.18.176```
```52.79.134.72```
```52.78.232.39```
```13.209.190.55```

##### 4) For communication, allow ```all traffic``` to your firewall ```egress``` rule.
###### 4) For communication, allow ```all traffic``` to your firewall ```egress``` rule.
```vim
IP version | Type | Protocol | Port range | Destination
---------------------------------------------------------------------------------------
IPv4 | All traffic | All | All | 0.0.0.0/0
```

{{< line_break >}}
*Please note that the above four IP addresses are attached to the Klaytn Kairos CNs.*
*Please note that the above four IP addresses are attached to the Kaia Kairos CNs.*

{{< line_break >}}
If you finish this step, please click the next button ```>``` on the right side of this page.
8 changes: 4 additions & 4 deletions content/10_prerequisites/20_package_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ draft: false

{{< line_break >}}

#### 2. Installation of Klaytn packages for CN and PN
_** We've already installed packages during the Pre-cypress stage. If you need to install newly, please refer these documents._
##### 1) CN - <https://docs.kaia.io/nodes/core-cell/install/install-consensus-nodes/>
##### 2) PN - <https://docs.kaia.io/nodes/core-cell/install/install-proxy-nodes/>
##### 2. Installation of Kaia packages for CN and PN
_** We've already installed packages during the Private Network stage. If you need to install newly, please refer these documents._
###### 1) CN - <https://docs.kaia.io/nodes/core-cell/install/install-consensus-nodes/>
###### 2) PN - <https://docs.kaia.io/nodes/core-cell/install/install-proxy-nodes/>

{{< line_break >}}
If you finish this step, please click the next button ```>``` on the right side of this page.
6 changes: 2 additions & 4 deletions content/10_prerequisites/_index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
+++
title = "Prerequisites"
date = 2022-07-11T10:17:42+09:00
weight = 10
chapter = true
weight = 1
type = "chapter"
pre = "<b>1. </b>"
draft = false
+++

### Chapter 1

# Prerequisites
The prerequisites for joining Kairos network are covered in this chapter.

{{< line_break >}}
Expand Down
10 changes: 5 additions & 5 deletions content/20_network_reset/10_stop_klaytn.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
---
title: "Stop the Klaytn service"
title: "Stop the Kaia service"
date: 2022-07-11T15:16:17+09:00
weight: 10
pre: "<b>A. </b>"
draft: false
---

{{< line_break >}}
#### 1. Stop the Klaytn service, if it is running.
##### 1) For CN,
##### 1. Stop the Kaia service, if it is running.
###### 1) For CN,
{{< highlight html >}}
$ sudo systemctl status kcnd
$ sudo systemctl stop kcnd
$ sudo systemctl status kcnd
{{< /highlight >}}

##### 2) For PN,
###### 2) For PN,
{{< highlight html >}}
$ sudo systemctl status kpnd
$ sudo systemctl stop kpnd
$ sudo systemctl status kpnd
{{< /highlight >}}

##### 3) If the services are not installed from ```yum```, you can stop the service like below,
###### 3) If the services are not installed from ```yum```, you can stop the service like below,
{{< highlight html >}}
$ sudo <installation_path>/kcnd status
$ sudo <installation_path>/kcnd stop
Expand Down
4 changes: 2 additions & 2 deletions content/20_network_reset/20_stop_telegraf.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ draft: false
---

{{< line_break >}}
#### 2. Stop the Telegraf service, if it is running.
##### 1) For both CN and PN,
##### 2. Stop the Telegraf service, if it is running.
###### 1) For both CN and PN,
{{< highlight html >}}
$ sudo systemctl status telegraf
$ sudo systemctl stop telegraf
Expand Down
Loading

0 comments on commit 9494f45

Please sign in to comment.