For plugin developer with minikube

[choonho]

This Guide is for plugin developer with Cloudforet minikube installation.

This is the history of AppDynamics Plugin development.

Installation

https://cloudforet.io/docs/setup_operation/quick_install/

Use spacectl

Create User. ex) stark@example.com

Create API Key

Following command will be executed by spacectl. So we need to create api token.

There is spacectl POD for developer in which spacectl is already installed.

choonhoson@tools-dev-usw1-vm-choonho: charts: $ k get pod -n spaceone | grep spacectl
spacectl-8cd55f46c-hvhds                  1/1     Running     0          14m

login spacectl pod as kubectl exec -ti spacectl-8cd55f46c-hvhds /bin/bash.

In the spacectl POD

Copy default.yaml to dev.yaml

root@spacectl-8cd55f46c-hvhds:~# ls
default.yaml
root@spacectl-8cd55f46c-hvhds:~# cp default.yaml dev.yaml
root@spacectl-8cd55f46c-hvhds:~# 

Edit dev.yaml

• update api_key
• delete unused endpoints

api_key: eyJhbGc#################_PUT_YOUR_API_KEY_########################dfsdjfksdfjlskfd
endpoints:
  identity: grpc://identity:50051
  inventory: grpc://inventory:50051
  monitoring: grpc://monitoring:50051
  plugin: grpc://plugin:50051
  repository: grpc://repository:50051
  secret: grpc://secret:50051
  statistics: grpc://statistics:50051
  config: grpc://config:50051
  notification: grpc://notification:50051

config spacectl

root@spacectl-8cd55f46c-hvhds:~# ls
default.yaml  dev.yaml
root@spacectl-8cd55f46c-hvhds:~# spacectl config init -f dev.yaml 
Environment [default]: dev
root@spacectl-8cd55f46c-hvhds:~# 

Local Repository

Now you have only one market place repository.

root@spacectl-8cd55f46c-hvhds:~# spacectl list repo
 repository_id     | name        | repository_type   | endpoint                                    | created_at
-------------------+-------------+-------------------+---------------------------------------------+--------------------------
 repo-4d7170b54b12 | Marketplace | remote            | grpc://repository.portal.spaceone.dev:50051 | 2023-05-15T10:42:42.416Z

 Count: 1 / 1

Create local repository

filename: local_repo.yaml

---
name: dev
repository_type: local

command

root@spacectl-8cd55f46c-hvhds:~# spacectl exec register repository.Repository -f local_repo.yaml
---
created_at: '2023-05-15T11:14:07.409Z'
name: dev
repository_id: repo-013a8ad03843
repository_type: local

List repositories

root@spacectl-8cd55f46c-hvhds:~# spacectl list repo
 repository_id     | name        | repository_type   | endpoint                                    | created_at
-------------------+-------------+-------------------+---------------------------------------------+--------------------------
 repo-4d7170b54b12 | Marketplace | remote            | grpc://repository.portal.spaceone.dev:50051 | 2023-05-15T10:42:42.416Z
 repo-013a8ad03843 | dev         | local             |                                             | 2023-05-15T11:14:07.409Z

 Count: 2 / 2

Provider

We have only 3 default providers.

root@spacectl-8cd55f46c-hvhds:~# spacectl list provider -c name,provider
 name         | provider
--------------+--------------
 AWS          | aws
 Google Cloud | google_cloud
 Azure        | azure

 Count: 3 / 3

Create new AppDynamics provider

filename: provider.yaml

provider: appdynamics
name: AppDynamics
template:
  service_account:
    schema:
      properties:
        name:
          minLength: 4.0
          title: Account Name
          type: string
      required:
      - name
      type: object
capability:
  supported_schema:
  - appdynamics_client_secret
tags:
  color: '#FF9900'
  external_link_template: https://accounts.appdynamics.com/overview
  icon: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/appdynamics-icon.svg
metadata:
  view:
    layouts:
      help:service_account:create:
        name: Creation Help
        options:
          markdown:
            en: "# Help for AppDynamicsS Users\n## Find Your AppDynamics Account Name\nGet your AppDynamics Account ID.\n\
              [AppDynamics Account Name](https://accounts.appdynamics.com/overview)\n"

command: spacectl exec create identity.Provider -f provider.yaml

root@spacectl-8cd55f46c-hvhds:~# spacectl exec create identity.Provider -f provider.yaml
---
capability:
  supported_schema:
  - appdynamics_client_secret
created_at: '2023-05-15T11:26:29.100Z'
metadata:
  view:
    layouts:
      help:service_account:create:
        name: Creation Help
        options:
          markdown:
            en: '# Help for AppDynamicsS Users

              ## Find Your AppDynamics Account Name

              Get your AppDynamics Account ID.

              [AppDynamics Account Name](https://accounts.appdynamics.com/overview)

              '
name: AppDynamics
provider: appdynamics
tags:
  color: '#FF9900'
  external_link_template: https://accounts.appdynamics.com/overview
  icon: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/appdynamics-icon.svg
template:
  service_account:
    schema:
      properties:
        name:
          minLength: 4.0
          title: Account Name
          type: string
      required:
      - name
      type: object

Now we have 4 providers

root@spacectl-8cd55f46c-hvhds:~# spacectl list provider -c name,provider
 name         | provider
--------------+--------------
 AWS          | aws
 Google Cloud | google_cloud
 Azure        | azure
 AppDynamics  | appdynamics

Schema

We are going to add schema in new repository.

root@spacectl-8cd55f46c-hvhds:~# spacectl list repo
 repository_id     | name        | repository_type   | endpoint                                    | created_at
-------------------+-------------+-------------------+---------------------------------------------+--------------------------
 repo-4d7170b54b12 | Marketplace | remote            | grpc://repository.portal.spaceone.dev:50051 | 2023-05-15T10:42:42.416Z
 repo-013a8ad03843 | dev         | local             |                                             | 2023-05-15T11:14:07.409Z

 Count: 2 / 2
root@spacectl-8cd55f46c-hvhds:~# spacectl list schema -p repository_id=repo-013a8ad03843
NO DATA

filename: schema.yaml

name: appdynamics_client_secret
schema:
  properties:
    client_name:
      minLength: 4.0
      title: Client Name
      type: string
    account_name:
      minLength: 4.0
      title: Account Name
      type: string
    client_secret:
      minLength: 4.0
      title: Client Secret
      type: string
    controller:
      minLength: 6.0
      title: Controller URL
      type: string
  required:
  - client_name
  - account_name
  - client_secret
  - controller
service_type: secret.credentials

command: spacectl exec create repository.Schema -f schema.yaml

root@spacectl-8cd55f46c-hvhds:~# spacectl exec create repository.Schema -f schema.yaml
---
created_at: '2023-05-15T11:32:03.740Z'
domain_id: domain-f7e7aadc1126
labels: []
name: appdynamics_client_secret
repository_info:
  name: dev
  repository_id: repo-013a8ad03843
  repository_type: local
schema:
  properties:
    account_name:
      minLength: 4.0
      title: Account Name
      type: string
    client_name:
      minLength: 4.0
      title: Client Name
      type: string
    client_secret:
      minLength: 4.0
      title: Client Secret
      type: string
    controller:
      minLength: 6.0
      title: Controller URL
      type: string
  required:
  - client_name
  - account_name
  - client_secret
  - controller
service_type: secret.credentials
tags: {}
updated_at: '2023-05-15T11:32:03.740Z'

After creating provider and schema, you can see appdynamics service account.

Register Plugin

Time to register my new plugin.

filename: register_plugin.yaml

name: Cisco AppDynamics
service_type: inventory.Collector
image: pyengine/plugin-appdynamics-inven-collector
capability: {}
tags:
  icon: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/appdynamics-icon.svg
template: {}
provider: appdynamics

command: spacectl exec register repository.Plugin -f register_plugin.yaml

root@spacectl-8cd55f46c-hvhds:~# spacectl exec register repository.Plugin -f register_plugin.yaml
---
capability: {}
created_at: '2023-05-15T11:40:39.337Z'
domain_id: domain-f7e7aadc1126
image: pyengine/plugin-appdynamics-inven-collector
labels: []
name: Cisco AppDynamics
plugin_id: plugin-appdynamics-inven-collector
provider: appdynamics
registry_config: {}
registry_type: DOCKER_HUB
registry_url: registry.hub.docker.com
repository_info:
  name: dev
  repository_id: repo-013a8ad03843
  repository_type: local
service_type: inventory.Collector
state: ENABLED
tags:
  icon: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/appdynamics-icon.svg
template: {}
updated_at: '2023-05-15T11:40:39.337Z'

You can see AppDynamics plugin in dev repository.