Step 4. Plugin Development Basic

[choonho]

Plugin Development Basic

Discord channel for Mentorship

Permanent invite link. https://discord.gg/csp3yt6SWw

Agenda

• Installation of Cloudforet with minikube
• Fork plugin-http-file-cost-datasource

You can install the Cloudforet, then create a user for service. You can create API user then create API Key for CLI.
You can register the local plugin marketplace for yourself. Then you can enable your custom plugin.

1. Installation of Cloudforet

Install Cloudforet following https://cloudforet.io/docs/setup_operation/quick_install/
In the Step 6. Set the Helm Values and Upgrade the Chart, use following values.yaml

upgrade the Cloudforet with below helm values.yaml file.

• update your ENDPOINT
• update TOKEN

console:
  production_json:
    CONSOLE_API:
      ENDPOINT: http://127.0.0.1:8081
    CONSOLE_API_V2:
      ENDPOINT: http://127.0.0.1:8082

cost-analysis:
  enabled: true
  scheduler: true
  worker: true
  replicas_worker: 1

supervisor:
  enabled: true
  image:
    name: cloudforet/supervisor
    version: 1.12.0
  application_scheduler:
    NAME: root
    HOSTNAME: spaceone-plugin.svc.cluster.local
    BACKEND: KubernetesConnector
    CONNECTORS:
      RepositoryConnector:
        endpoint:
          v1: grpc://repository:50051
      PluginConnector:
        endpoint:
          v1: grpc://plugin:50051
      KubernetesConnector:
        namespace: spaceone-plugin
        start_port: 50051
        end_port: 50052
        headless: true
        replica:
          inventory.Collector: 1
          monitoring.DataSource: 1
          cost_analysis.DataSource: 1

global:
  shared_conf:
    TOKEN: ......

2. Create User

Click Sign in for Root Account

Login as admin / Admin123!@#

Menu: Administration > IAM

Click + Add, then create User as Domain Admin

• User ID format is e-mail
• Check ID is required
• Set your password
• Enable Admin Role

Click profile in upper right. Sign Out Root Account

Login as general User

3. Create API Token

Menu: Administration > IAM > User

Check User ID, then select API Key in the tap menu.

+ Create API Key

Download YAML file

In the Download directory, there will be spacectl_config.yml file

4. Access to CLI POD

Cloudforet provides CLI tool, spacectl as K8S POD

Access to CLI POD

kubectl exec -ti {POD NAME} -n spaceone -- /bin/bash

In the POD, there is default.yml

cp default.yml local.yml

default.yml is read only file, you cannot edit default.yml

Update local.yml

• append api_key: section, using spacectl_config.yml file in your download directory.

Update command

spacectl config init -f local.yml

Check API is working

spacectl api-resources

5. Create Personal Cloudforet Plugin Repository

Using CLI, create Personal Plugin Repository.

spacectl exec register repository.Repository -p name="My Private Repo" -p repository_type=local 

Check the list of repository

spacectl list repo

6. Register my own plugin

create register_plugin.yml file

name: HTTP file Cost Analysis Data Source
service_type: cost_analysis.DataSource
image: spaceone/plugin-http-file-cost-datasource
capability: {}
tags:
  description: HTTP File Data Source
  icon: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/csv_icon.png
  long_description: This plugin can collect predefined CSV format data through http(s) and use it as cost data. Easily integrate data into Cost Analysis from CSV file regardless of any data as possible like API usage.
template: {}

Command

spacectl exec register repository.Plugin -f register_plugin.yml

Check the plugins

# List repository
spacectl list repo

# List plugin of a specific repo
spacectl list plugin -p repository_id=<Repository ID>

7. Enable Plugin

In your brower, there is default screen for Cost Explorer menu.

When you enable plugin, then this screen will be changed to real data screen.

open data_source.yml

---
name: CSV File
data_source_type: EXTERNAL
plugin_info:
  secret_data:
    status: NOT IMPLEMENTED
  plugin_id: plugin-http-file-cost-datasource
  options:
    base_url:
      - https://raw.githubusercontent.com/cloudforet-io/plugin-http-file-cost-datasource/master/examples/cost_example.csv
    field_mapper:
      additional_info:
        Account: account

Command

spacectl exec register cost_analysis.DataSource -f data_source.yml

8. Sync Cost Data

Remember your data_source_id in Step 7.

spacectl exec sync cost_analysis.DataSource -p data_source_id=<DATA SOURCE ID> -p start=2023-09

Submission

• Screenshot of your Custom Billing Dashboard

Reference

spacectl: https://github.com/cloudforet-io/spacectl

[Cvr421]

Hello @choonho i have completed the step 4 but i am not able to upload the image on LFX. Is that we should have to upload the pdf file

[choonho]

Great! You did very well. Don't you have any problem of the minikube memory? I think 4096MB of minikube may be small.

[Cvr421]

@choonho
No actually everything works very smoothly didn't get any Minikube memory issues .
Should i convert the image in pdf format and then upload it to the LFX task.

[choonho]

No, I updated your status as completed.

[Cvr421]

No, I updated your status as completed.

Great thanks 👍

[py-dev-nandini-12]

Hi @choonho ,
I have uploaded the task.

[Ayush-Sharma410]

Hi @choonho
I have uploaded the task.