diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 2a421ca..e1755d5 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -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 \ No newline at end of file + # 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 \ No newline at end of file diff --git a/.gitmodules b/.gitmodules index 01a0b24..5c05f90 100644 --- a/.gitmodules +++ b/.gitmodules @@ -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 diff --git a/README.md b/README.md index 0669d4c..5cba68a 100644 --- a/README.md +++ b/README.md @@ -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) @@ -13,10 +13,10 @@ ## Overview -**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 @@ -30,20 +30,21 @@ ## Contributing -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 diff --git a/static/css/theme-klaytn.css b/assets/css/theme-kaia.css similarity index 80% rename from static/css/theme-klaytn.css rename to assets/css/theme-kaia.css index c5081bc..42c7dd0 100644 --- a/static/css/theme-klaytn.css +++ b/assets/css/theme-kaia.css @@ -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
separator in menu */ + --MENU-VISITED-color: #BFF009; /* Color of 'page visited' icons in menu */ + --MENU-SECTION-HR-color: #144625; /* Color of
separator in menu */ } diff --git a/config/gh-pages/config.toml b/config/gh-pages/config.toml deleted file mode 100644 index e936c46..0000000 --- a/config/gh-pages/config.toml +++ /dev/null @@ -1,76 +0,0 @@ -baseURL = "/klaytn-baobab-setup-workshop" -languageCode = 'en-us' -title = 'Klaytn CCO Onboarding - Baobab' -uglyurls = true -canonifyURLs = true - -# Change the default theme to be use when building the site with Hugo -theme = "hugo-theme-learn" - -# For search functionality -[outputs] -home = [ "HTML", "RSS", "JSON"] - -[params] -# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page. -# Useful to give opportunity to people to create merge request for your doc. -# See the config.toml file from this documentation site to have an example. -editURL = "" -# Author of the site, will be used in meta information -author = "Klaytn DevOps team" -# Description of the site, will be used in meta information -description = "" -# Shows a checkmark for visited pages on the menu -showVisitedLinks = true -# Disable search function. It will hide search bar -disableSearch = false -# Javascript and CSS cache are automatically busted when new version of site is generated. -# Set this to true to disable this behavior (some proxies don't handle well this optimization) -disableAssetsBusting = false -# Set this to true to disable copy-to-clipboard button for inline code. -disableInlineCopyToClipBoard = false -# A title for shortcuts in menu is set by default. Set this to true to disable it. -disableShortcutsTitle = false -# If set to false, a Home button will appear below the search bar on the menu. -# It is redirecting to the landing page of the current language if specified. (Default is "/") -disableLandingPageButton = true -# When using mulitlingual website, disable the switch language button. -disableLanguageSwitchingButton = false -# Hide breadcrumbs in the header and only show the current page title -disableBreadcrumb = true -# If set to true, prevents Hugo from including the mermaid module if not needed (will reduce load times and traffic) -disableMermaid = false -# Specifies the remote location of the mermaid js -customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js" -# Hide Next and Previous page buttons normally displayed full height beside content -disableNextPrev = false -# Order sections in menu by "weight" or "title". Default to "weight" -ordersectionsby = "weight" -# Change default color scheme with a variant one. Can be "red", "blue", "green". -themeVariant = "klaytn" -# Provide a list of custom css files to load relative from the `static/` folder in the site root. -custom_css = ["css/foo.css", "css/bar.css"] -# Change the title separator. Default to "::". -titleSeparator = "-" - -[Lanugages] -[Lanugages.en] -landingPageURL = "/" -landingPageName = "Home" - -[[menu.shortcuts]] -name = " Workshop Github repo" -identifier = "ds" -url = "https://github.com/klaytn/klaytn-baobab-setup-workshop" -weight = 10 - -[[menu.shortcuts]] -name = " Klaytn Documentation" -identifier = "klaytndoc" -url = "https://docs.klaytn.foundation/" -weight = 20 - -[[menu.shortcuts]] -name = " Klaytn Foundation" -url = "https://klaytn.foundation/" -weight = 30 diff --git a/content/10_prerequisites/10_firewall_configuration.md b/content/10_prerequisites/10_firewall_configuration.md index db60372..e859bdd 100644 --- a/content/10_prerequisites/10_firewall_configuration.md +++ b/content/10_prerequisites/10_firewall_configuration.md @@ -7,27 +7,27 @@ 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 --------------------------------------------------------------------------------------- @@ -35,7 +35,7 @@ IPv4 | All traffic | All | All | 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. diff --git a/content/10_prerequisites/20_package_installation.md b/content/10_prerequisites/20_package_installation.md index 16fd76c..006bfd0 100644 --- a/content/10_prerequisites/20_package_installation.md +++ b/content/10_prerequisites/20_package_installation.md @@ -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 - -##### 2) PN - +##### 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 - +###### 2) PN - {{< line_break >}} If you finish this step, please click the next button ```>``` on the right side of this page. \ No newline at end of file diff --git a/content/10_prerequisites/_index.md b/content/10_prerequisites/_index.md index 3c71fd8..3ff27f3 100644 --- a/content/10_prerequisites/_index.md +++ b/content/10_prerequisites/_index.md @@ -1,15 +1,13 @@ +++ title = "Prerequisites" date = 2022-07-11T10:17:42+09:00 -weight = 10 -chapter = true +weight = 1 +type = "chapter" pre = "1. " draft = false +++ -### Chapter 1 -# Prerequisites The prerequisites for joining Kairos network are covered in this chapter. {{< line_break >}} diff --git a/content/20_network_reset/10_stop_klaytn.md b/content/20_network_reset/10_stop_klaytn.md index 2f75da7..00bac20 100644 --- a/content/20_network_reset/10_stop_klaytn.md +++ b/content/20_network_reset/10_stop_klaytn.md @@ -1,5 +1,5 @@ --- -title: "Stop the Klaytn service" +title: "Stop the Kaia service" date: 2022-07-11T15:16:17+09:00 weight: 10 pre: "A. " @@ -7,22 +7,22 @@ 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 /kcnd status $ sudo /kcnd stop diff --git a/content/20_network_reset/20_stop_telegraf.md b/content/20_network_reset/20_stop_telegraf.md index 5e826cf..af4a58c 100644 --- a/content/20_network_reset/20_stop_telegraf.md +++ b/content/20_network_reset/20_stop_telegraf.md @@ -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 diff --git a/content/20_network_reset/30_remove_data_and_log.md b/content/20_network_reset/30_remove_data_and_log.md index 1c2a1fe..f3dd279 100644 --- a/content/20_network_reset/30_remove_data_and_log.md +++ b/content/20_network_reset/30_remove_data_and_log.md @@ -7,25 +7,25 @@ draft: false --- {{< line_break >}} -#### 3. Remove existing chaindata and log for pre-cypress. +##### 3. Remove existing chaindata and log for Private Network. -##### 0) During pre-cypress, you did set for Ansible deployment. But you can check this out if you can't remember where your data directory is located. +###### 0) During Private Network, you did set for Ansible deployment. But you can check this out if you can't remember where your data directory is located. {{< highlight html >}} $ grep "DATA_DIR" /etc/kpnd/conf/kpnd.conf {{< /highlight >}} -##### 1) For CN, +###### 1) For CN, {{< highlight html >}} -$ sudo rm -Rf /kcnd/data/klay/chaindata -$ sudo rm -Rf /kcnd/data/klay/lightchaindata -$ sudo rm -Rf /kcnd/log/* +$ sudo rm -Rf /kcnd/data/klay/chaindata +$ sudo rm -Rf /kcnd/data/klay/lightchaindata +$ sudo rm -Rf /kcnd/log/* {{< /highlight >}} -##### 2) For PN, +###### 2) For PN, {{< highlight html >}} -$ sudo rm -Rf /kpnd/data/klay/chaindata -$ sudo rm -Rf /kpnd/data/klay/lightchaindata -$ sudo rm -Rf /kpnd/log/* +$ sudo rm -Rf /kpnd/data/klay/chaindata +$ sudo rm -Rf /kpnd/data/klay/lightchaindata +$ sudo rm -Rf /kpnd/log/* {{< /highlight >}} {{< line_break >}} diff --git a/content/20_network_reset/40_replace_bls-nodekey.md b/content/20_network_reset/40_replace_bls-nodekey.md index fb0de22..4dc0d93 100644 --- a/content/20_network_reset/40_replace_bls-nodekey.md +++ b/content/20_network_reset/40_replace_bls-nodekey.md @@ -7,23 +7,23 @@ draft: false --- {{< line_break >}} -#### 4. Replace bls-nodekey on the CN - Except Bughole & Certik. +##### 4. Replace bls-nodekey on the CN - Except Bughole & Certik. > BLS-Nodekey is your Private key what you generate with Klay Tool. -![CN](https://raw.githubusercontent.com/klaytn/klaytn-pre-cypress-setup-workshop/main/static/images/nodekey.png) +![CN](/images/nodekey.png) In order to operate a node, a `bls-nodekey` is required. The KCN binary will create a new one for you if you do not have it. {{< line_break >}} If you have one, you need to put your `bls-nodekey` into the `data` directory. -##### 1) Rename auto-generated bls-key - will be deleted later +###### 1) Rename auto-generated bls-key - will be deleted later {{< highlight html >}} -$ mv //klay/bls-nodekey //data/klay/bls-nodekey_temp +$ mv //klay/bls-nodekey //data/klay/bls-nodekey_temp {{< /highlight >}} {{< line_break >}} -##### 2) Create bls-nodekey file +###### 2) Create bls-nodekey file {{< highlight html >}} $ vi //bls-nodekey {{< /highlight >}} diff --git a/content/20_network_reset/_index.md b/content/20_network_reset/_index.md index a33a82f..6c00926 100644 --- a/content/20_network_reset/_index.md +++ b/content/20_network_reset/_index.md @@ -1,16 +1,14 @@ +++ title = "Reset Network Configuration" date = 2022-07-11T10:24:36+09:00 -weight = 20 -chapter = true +weight = 2 +type = "chapter" pre = "2. " +++ -### Chapter 2 -# Reset Network Configuration -#### In this chapter, you will reset the Pre-cypress network configuration. +###### In this chapter, you will reset the Private Network configuration. {{< line_break >}} {{< line_break >}} diff --git a/content/30_download_chaindata/20_unarchive_chaindata.md b/content/30_download_chaindata/20_unarchive_chaindata.md index c8291c8..2842de7 100644 --- a/content/30_download_chaindata/20_unarchive_chaindata.md +++ b/content/30_download_chaindata/20_unarchive_chaindata.md @@ -7,16 +7,16 @@ draft: false --- {{< line_break >}} -#### 2. Extract the chaindata downloaded to the DATA_DIR. +##### 2. Extract the chaindata downloaded to the DATA_DIR. -##### 1) For CN, +###### 1) For CN, {{< highlight html >}} -$ tar -C /kcnd/data -xvf kaia-kairos-pruning-chaindata-20240819010812.tar.gz --exclude klay/chaindata/receipts +$ tar -C /kcnd/data -xvf kaia-kairos-pruning-chaindata-20240819010812.tar.gz --exclude klay/chaindata/receipts {{< /highlight >}} -##### 2) For PN, +###### 2) For PN, {{< highlight html >}} -$ tar -C /kpnd/data -xvf kaia-kairos-pruning-chaindata-20240819010812.tar.gz --exclude klay/chaindata/receipts +$ tar -C /kpnd/data -xvf kaia-kairos-pruning-chaindata-20240819010812.tar.gz --exclude klay/chaindata/receipts {{< /highlight >}} _** If you want to reduce the time for extracting, please refer this [pigz](https://zlib.net/pigz/) example._ @@ -24,7 +24,7 @@ _** If you want to reduce the time for extracting, please refer this [pigz](http (Amazon Linux 2) $ sudo amazon-linux-extras install epel (CentOS) $ sudo yum install epel-release -y $ sudo yum install pigz -$ tar -I pigz -C /k*nd/data -xvf kaia-kairos-pruning-chaindata-20240819010812.tar.gz --exclude klay/chaindata/receipts +$ tar -I pigz -C /k*nd/data -xvf kaia-kairos-pruning-chaindata-20240819010812.tar.gz --exclude klay/chaindata/receipts {{< /highlight >}} {{< line_break >}} diff --git a/content/30_download_chaindata/30_remove_chaindata.md b/content/30_download_chaindata/30_remove_chaindata.md index 2129b9d..6c8605f 100644 --- a/content/30_download_chaindata/30_remove_chaindata.md +++ b/content/30_download_chaindata/30_remove_chaindata.md @@ -7,9 +7,9 @@ draft: false --- {{< line_break >}} -#### 3. You can remove the chaindata downloaded, if the previous step is completed. +##### 3. You can remove the chaindata downloaded, if the previous step is completed. -##### 1) For both CN and PN, +###### 1) For both CN and PN, {{< highlight html >}} $ rm kaia-kairos-chaindata-****************.tar.gz {{< /highlight >}} diff --git a/content/30_download_chaindata/_index.md b/content/30_download_chaindata/_index.md index 66fbcac..2b2049d 100644 --- a/content/30_download_chaindata/_index.md +++ b/content/30_download_chaindata/_index.md @@ -1,17 +1,15 @@ +++ title = "Fast Sync with Kairos" date = 2022-07-11T10:25:05+09:00 -weight = 30 -chapter = true +weight = 3 +type = "chapter" pre = "3. " +++ -### Chapter 3 + -# Fast Sync with Kairos chaindata - -#### Klaytn has been snapshotting Kairos chaindata once a day. -#### In this chapter, we are going to explore where the snapshot is stored, and the latest chaindata snapshot of Kairos will be used to sync as fast as possible. +##### Kaia has been snapshotting Kairos chaindata once a day. +##### In this chapter, we are going to explore where the snapshot is stored, and the latest chaindata snapshot of Kairos will be used to sync as fast as possible. {{< line_break >}} {{< line_break >}} diff --git a/content/40_configure_network/10_prepare_genesis_for_baobab.md b/content/40_configure_network/10_prepare_genesis_for_baobab.md index e504cd7..6ba8ee6 100644 --- a/content/40_configure_network/10_prepare_genesis_for_baobab.md +++ b/content/40_configure_network/10_prepare_genesis_for_baobab.md @@ -7,14 +7,14 @@ draft: false --- {{< line_break >}} -#### 1. Remove or backup existing genesis.json for Pre-cypress. -##### 1) For CN, +##### 1. Remove or backup existing genesis.json for Private Network. +###### 1) For CN, {{< highlight html >}} -$ mv /kcnd/data/genesis.json /kcnd/data/genesis.json.pre-cypress +$ mv /kcnd/data/genesis.json /kcnd/data/genesis.json.private-network {{< /highlight >}} -##### 2) For PN, +###### 2) For PN, {{< highlight html >}} -$ mv /kpnd/data/genesis.json /kpnd/data/genesis.json.pre-cypress +$ mv /kpnd/data/genesis.json /kpnd/data/genesis.json.private-network {{< /highlight >}} {{< line_break >}} diff --git a/content/40_configure_network/20_node_configuration.md b/content/40_configure_network/20_node_configuration.md index 9a0f399..a750607 100644 --- a/content/40_configure_network/20_node_configuration.md +++ b/content/40_configure_network/20_node_configuration.md @@ -7,10 +7,10 @@ draft: false --- {{< line_break >}} -#### 1. Modify network, discovery and boot node information. +##### 1. Modify network, discovery and boot node information. _** Note that CN and PN have some different information._ -##### 1) For CN, your configuration should be modified as shown below. +###### 1) For CN, your configuration should be modified as shown below. {{< highlight html >}} $ egrep "^NETWORK|NO_DISCOVER|BOOTNODES|ADDITIONAL" /etc/kcnd/conf/kcnd.conf NETWORK="baobab" @@ -20,7 +20,7 @@ BOOTNODES="kni://979159c738bb0c8c60b36267c56d2b4d4a995326be666460c3d612856caab52 ADDITIONAL="--state.trie-cache-limit 5000 --state.live-pruning" {{< /highlight >}} -##### 2) For PN +###### 2) For PN {{< highlight html >}} $ egrep "^NETWORK|NO_DISCOVER|BOOTNODES|ADDITIONAL" /etc/kpnd/conf/kpnd.conf NETWORK="baobab" @@ -31,11 +31,11 @@ ADDITIONAL="--state.trie-cache-limit 5000 --state.live-pruning" {{< /highlight >}} {{< line_break >}} -#### 2. Check if the static-nodes.json has correct information for your PN. +##### 2. Check if the static-nodes.json has correct information for your PN. _** Unlike CN, PN uses a static-nodes.json file to find out where to connect._ _** If only CN information is found in the file, it is correctly configured._ -##### 1) For both PN1 and PN2, +###### 1) For both PN1 and PN2, {{< highlight html >}} [ "CN_KNI_ADDRESS@CN_INTERNAL_IP:PORT?discport=0&ntype=cn" diff --git a/content/40_configure_network/30_telegraf_configuration.md b/content/40_configure_network/30_telegraf_configuration.md index 3ff235c..d1ec22a 100644 --- a/content/40_configure_network/30_telegraf_configuration.md +++ b/content/40_configure_network/30_telegraf_configuration.md @@ -7,11 +7,11 @@ draft: false --- {{< line_break >}} -#### 1. To monitor your nodes in Kairos Dashboard, please change the influxdb configuration as below: +##### 1. To monitor your nodes in Kairos Dashboard, please change the influxdb configuration as below: -##### 1) For both CN and PN, +###### 1) For both CN and PN, {{< highlight html >}} -$ grep -A2 "influxdb" /etc/telegraf/telegraf.d/klaytn.conf +$ grep -A2 "influxdb" /etc/telegraf/telegraf.d/kaia.conf [[outputs.influxdb]] urls = [ "http://15.164.55.202:8086" ] database = "klaytn_beta_baobab" diff --git a/content/40_configure_network/_index.md b/content/40_configure_network/_index.md index f7ff488..1954875 100644 --- a/content/40_configure_network/_index.md +++ b/content/40_configure_network/_index.md @@ -1,17 +1,15 @@ +++ title = "Configure Kairos Network" date = 2022-07-11T10:25:55+09:00 -weight = 40 -chapter = true +weight = 4 +type = "chapter" pre = "4. " +++ -### Chapter 4 -# Configure Kairos Network -#### Now, we are going to re-configure networks to join Kairos. -#### +##### Now, we are going to re-configure networks to join Kairos. +##### {{< line_break >}} {{< line_break >}} diff --git a/content/50_start_services/10_start_klaytn_service.md b/content/50_start_services/10_start_klaytn_service.md index bf3883a..1409c9d 100644 --- a/content/50_start_services/10_start_klaytn_service.md +++ b/content/50_start_services/10_start_klaytn_service.md @@ -1,5 +1,5 @@ --- -title: "Start the klaytn services" +title: "Start the kaia services" date: 2022-07-11T18:37:31+09:00 weight: 10 pre: "A. " @@ -7,22 +7,22 @@ draft: false --- {{< line_break >}} -#### 1. Start the Klaytn service, if it is running. -##### 1) For CN, +##### 1. Start the Kaia service, if it is running. +###### 1) For CN, {{< highlight html >}} $ sudo systemctl status kcnd $ sudo systemctl start kcnd $ sudo systemctl status kcnd {{< /highlight >}} -##### 2) For PN, +###### 2) For PN, {{< highlight html >}} $ sudo systemctl status kpnd $ sudo systemctl start kpnd $ sudo systemctl status kpnd {{< /highlight >}} -##### 3) If the services are not installed from ```yum```, you can start the service like below, +###### 3) If the services are not installed from ```yum```, you can start the service like below, {{< highlight html >}} $ sudo /kcnd status $ sudo /kcnd start diff --git a/content/50_start_services/20_start_telegraf_service.md b/content/50_start_services/20_start_telegraf_service.md index b018663..7dc406c 100644 --- a/content/50_start_services/20_start_telegraf_service.md +++ b/content/50_start_services/20_start_telegraf_service.md @@ -7,8 +7,8 @@ draft: false --- {{< line_break >}} -#### 2. Start the Telegraf service, if it is running. -##### 1) For both CN and PN, +##### 2. Start the Telegraf service, if it is running. +###### 1) For both CN and PN, {{< highlight html >}} $ sudo systemctl status telegraf $ sudo systemctl start telegraf diff --git a/content/50_start_services/30_check_the_services.md b/content/50_start_services/30_check_the_services.md index 277a85b..81b6a07 100644 --- a/content/50_start_services/30_check_the_services.md +++ b/content/50_start_services/30_check_the_services.md @@ -7,20 +7,20 @@ draft: false --- {{< line_break >}} -#### 3. Watch the service log to confirm if your nodes are correctly joined. +##### 3. Watch the service log to confirm if your nodes are correctly joined. _** If the node is not a proposer at that block, and the consensus is successful, the node have executed(==validates) the block. In other words, a block is inserted._ -_** You can refer [this document](https://docs.klaytn.foundation/node/node-log#info-logs) for more details about node log. +_** You can refer [this document](https://docs.kaia.io/misc/operation/node-log/#info-logs) for more details about node log. -##### 1) For CN, +###### 1) For CN, {{< highlight html >}} -$ tail /kcnd/log/kcnd.out +$ tail /kcnd/log/kcnd.out INFO Inserted a new block number=14 hash=13cbfc…f007fc txs=0 gas=0 elapsed=793.458µs processTxs=167ns finalize=157.708µs validateState=7.542µs totalWrite=443.417µs trieWrite=256.667µs {{< /highlight >}} -##### 2) For PN, +###### 2) For PN, {{< highlight html >}} -$ tail /kcnd/log/kpnd.out +$ tail /kcnd/log/kpnd.out INFO Inserted a new block number=14 hash=13cbfc…f007fc txs=0 gas=0 elapsed=793.458µs processTxs=167ns finalize=157.708µs validateState=7.542µs totalWrite=443.417µs trieWrite=256.667µs {{< /highlight >}} diff --git a/content/50_start_services/40_check_monitoring_dashboard.md b/content/50_start_services/40_check_monitoring_dashboard.md index fab0867..8742eb0 100644 --- a/content/50_start_services/40_check_monitoring_dashboard.md +++ b/content/50_start_services/40_check_monitoring_dashboard.md @@ -7,17 +7,17 @@ draft: false --- {{< line_break >}} -#### 4. Take a look at Grafana dashboard to confirm if your nodes are correctly joined to Kairos network. +##### 4. Take a look at Grafana dashboard to confirm if your nodes are correctly joined to Kairos network. -**Link : [Kairos Grafana](http://baobab.klaytn.net:3000/d/K2aqGNDZz/dashboardcco?orgId=1&refresh=5s&from=now-5m&to=now)** +**Link : [Kairos Grafana](http://kairos.node.kaia.io:3000/d/K2aqGNDZz/dashboardcco?orgId=1&refresh=5s&from=now-5m&to=now)** {{< line_break >}} _** You can refer this document to check your services further._ -_https://docs.klaytn.foundation/node/core-cell/installation-guide/testing-the-core-cell#kcn-console-kpn-console_ +_https://docs.kaia.io/nodes/core-cell/install/install-consensus-nodes/#testing-the-core-cell-_ {{< line_break >}} -#### If your nodes are shown and CN/PN Inter Connections looks 2 in this dashboard, everything is configured normally. -#### Please send a message to Klaytn DevOps by Slack channel #cco_7th_batch. +##### If your nodes are shown and CN/PN Inter Connections looks 2 in this dashboard, everything is configured normally. +##### Please send a message to Kaia DevOps by Slack channel #cco_7th_batch. {{< line_break >}} diff --git a/content/50_start_services/_index.md b/content/50_start_services/_index.md index ad5e1a0..114b94b 100644 --- a/content/50_start_services/_index.md +++ b/content/50_start_services/_index.md @@ -1,16 +1,14 @@ +++ title = "Start the services" date = 2022-07-11T18:26:28+09:00 -weight = 50 -chapter = true +weight = 5 +type = "chapter" pre = "5. " +++ -### Chapter 5 -# Start the services -#### Now, we are ready to start Klaytn service for Kairos. +##### Now, we are ready to start Kaia service for Kairos. {{< line_break >}} diff --git a/content/60_conclusion/_index.md b/content/60_conclusion/_index.md index 89e42fb..39bbf8c 100644 --- a/content/60_conclusion/_index.md +++ b/content/60_conclusion/_index.md @@ -1,11 +1,11 @@ +++ title = "Conclusion" date = 2022-07-11T18:51:05+09:00 -weight = 60 -chapter = true +weight = 6 +type = "chapter" pre = "6. " +++ -![Klaytn Baobab_Logo](/images/Logo-baobab.png) +![Kaia Logo](/images/Logo-1.png) ### Congratulations! Now, you are playing in the Kairos network. \ No newline at end of file diff --git a/content/_index.md b/content/_index.md index f8fb360..0c6feeb 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,15 +1,14 @@ +++ -title = "Klaytn - CCO Onboarding - Kairos" +title = "Kaia - CCO Onboarding - Kairos" date = 2022-07-11T10:01:37+09:00 weight = 0 -chapter = true +type = "chapter" pre = "0. " draft = false +++ -![Klaytn Logo](/images/Logo-1.png) -# CCO Onboarding - Kairos +![Kaia Logo](/images/Logo-1.png) -This online instruction let you join Klaytn Kairos network. +This online instruction let you join Kaia Kairos network. If Consensus/Proxy node setup is already completed, you can start with chapter 2. \ No newline at end of file diff --git a/config/_default/config.toml b/hugo.toml similarity index 69% rename from config/_default/config.toml rename to hugo.toml index aaed4e9..a16f3e2 100644 --- a/config/_default/config.toml +++ b/hugo.toml @@ -1,21 +1,15 @@ baseURL = '/' -languageCode = 'en-us' -title = 'Klaytn CCO Onboarding - Baobab' -# Change the default theme to be use when building the site with Hugo -theme = "hugo-theme-learn" +languageCode = 'en-us' +title = 'Kaia CCO Onboarding - Kairos' -# For search functionality -[outputs] -home = [ "HTML", "RSS", "JSON"] +theme = 'hugo-theme-relearn' +canonifyURLs = true [params] -# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page. -# Useful to give opportunity to people to create merge request for your doc. -# See the config.toml file from this documentation site to have an example. -editURL = "" +themeVariant = 'kaia' # Author of the site, will be used in meta information -author = "Klaytn DevOps team" +author = "Kaia DevOps team" # Description of the site, will be used in meta information description = "" # Shows a checkmark for visited pages on the menu @@ -44,31 +38,29 @@ customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js" disableNextPrev = false # Order sections in menu by "weight" or "title". Default to "weight" ordersectionsby = "weight" -# Change default color scheme with a variant one. Can be "red", "blue", "green". -themeVariant = "klaytn" -# Provide a list of custom css files to load relative from the `static/` folder in the site root. -custom_css = ["css/foo.css", "css/bar.css"] # Change the title separator. Default to "::". titleSeparator = "-" +# Provide a list of custom css files to load relative from the `static/` folder in the site root. +custom_css = ["css/foo.css", "css/bar.css"] -[Lanugages] -[Lanugages.en] +[lanugages] +[lanugages.en] landingPageURL = "/" landingPageName = "Home" [[menu.shortcuts]] name = " Github repo" identifier = "ds" -url = "https://github.com/klaytn/klaytn" +url = "https://github.com/kaiachain/kaia" weight = 10 [[menu.shortcuts]] -name = " Klaytn Documentation" -identifier = "klaytndoc" -url = "https://docs.klaytn.foundation/" +name = " Kaia Documentation" +identifier = "kaiadoc" +url = "https://docs.kaia.io/" weight = 20 [[menu.shortcuts]] -name = " Klaytn Foundation" -url = "https://klaytn.foundation/" +name = " Kaia DLT Foundation" +url = "https://www.kaia.io/" weight = 30 diff --git a/layouts/partials/menu-footer.html b/layouts/partials/menu-footer.html index 92a08f2..b1ed1a7 100644 --- a/layouts/partials/menu-footer.html +++ b/layouts/partials/menu-footer.html @@ -1 +1 @@ -

© Klaytn Foundation 2022. All rights reserved.

\ No newline at end of file +

© Kaia Labs Limited 2024. All rights reserved.

\ No newline at end of file diff --git a/static/images/Kaia-docs.png b/static/images/Kaia-docs.png new file mode 100644 index 0000000..ca34c62 Binary files /dev/null and b/static/images/Kaia-docs.png differ diff --git a/static/images/Logo-1.png b/static/images/Logo-1.png index 0169be3..4e34b38 100644 Binary files a/static/images/Logo-1.png and b/static/images/Logo-1.png differ diff --git a/static/images/Logo-2.png b/static/images/Logo-2.png index 0da50a4..c43a51c 100644 Binary files a/static/images/Logo-2.png and b/static/images/Logo-2.png differ diff --git a/static/images/nodekey.png b/static/images/nodekey.png new file mode 100644 index 0000000..0bb1725 Binary files /dev/null and b/static/images/nodekey.png differ diff --git a/themes/hugo-theme-learn b/themes/hugo-theme-learn deleted file mode 160000 index e817f53..0000000 --- a/themes/hugo-theme-learn +++ /dev/null @@ -1 +0,0 @@ -Subproject commit e817f53d690d35f181c896e0e320cb40f797e88c diff --git a/themes/hugo-theme-relearn b/themes/hugo-theme-relearn new file mode 160000 index 0000000..28fce6b --- /dev/null +++ b/themes/hugo-theme-relearn @@ -0,0 +1 @@ +Subproject commit 28fce6b04c414523280c53ee02f9f3a94d9d23da