ソースコードの解釈:KubeVelaがappfileをK8s固有のリソースオブジェクトに変換する方法

1.png

著者|ファンダヨン

KubeVelaは、AlibabaCloudとMicrosoftCloudが共同でリリースしたKubernetesとクラウドネイティブアプリケーション開発モデルOAMに基づく、シンプルで使いやすく、拡張性の高いクラウドネイティブアプリケーション管理エンジンです。

KubeVelaは、Golangで記述されたOAMモデルに基づいて特定の実装を構築し、ユーザー向けのクラウドネイティブアプリケーションプラットフォームをエンドツーエンドで構築して、比較的完全なソリューションを提供できます。

KubeVelaプロジェクトは、2020年7月にコミュニティで開始されました。Alibaba、Microsoft、Crossplaneなどのエンジニアを含むコミュニティのボランティアに歓迎され、プロジェクト開発作業に参加しました。彼らは、OAMの実践におけるさまざまな経験と教訓をKubeVelaプロジェクトにまとめました。

この記事の主な目的は、KubeVelaがアプリファイルをK8sの特定のリソースオブジェクトに変換する方法を探ることです。

このプロセスは通常、次の2つの段階に分けられます。

  1. appfileをK8sのアプリケーションに変換する
  2. アプリケーションは対応するK8sリソースオブジェクトに変換されます
# vela.yaml
name: test
services:
  nginx:
    type: webservice
    image: nginx
    env:
    - name: NAME
      value: kubevela

    # svc trait
    svc:
      type: NodePort
      ports:
      - port: 80
        nodePort: 32017

展開は、velaupコマンドで完了できます。

velaupコマンド

提案:velaコマンドラインツールコードを見る前に、cobraフレームワークを簡単に見てみましょう。

// references/cli/up.go
// NewUpCommand will create command for applying an AppFile
func NewUpCommand(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command {
  cmd := &cobra.Command{
    Use:                   "up",
    DisableFlagsInUseLine: true,
    Short:                 "Apply an appfile",
    Long:                  "Apply an appfile",
    Annotations: map[string]string{
      types.TagCommandType: types.TypeStart,
    },
    PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
      return c.SetConfig()
    },
    RunE: func(cmd *cobra.Command, args []string) error {
      velaEnv, err := GetEnv(cmd)
      if err != nil {
        return err
      }
      kubecli, err := c.GetClient()
      if err != nil {
        return err
      }

      o := &common.AppfileOptions{
        Kubecli: kubecli,
        IO:      ioStream,
        Env:     velaEnv,
      }
      filePath, err := cmd.Flags().GetString(appFilePath)
      if err != nil {
        return err
      }
      return o.Run(filePath, velaEnv.Namespace, c)
    },
  }
  cmd.SetOut(ioStream.Out)

  cmd.Flags().StringP(appFilePath, "f", "", "specify file path for appfile")
  return cmd
}

上記のソースコードは、velaupコマンドのエントリポイントを示しています。

PresistentPreRunE関数では、c.SetConfig()を呼び出すことにより、Kuberentes構成情報kubeconfigが挿入されます。

RunE関数の場合:

  • まず、velaのenv変数を取得します。velaEnv.NamespaceはKubernetesの名前空間に対応します。

  • 次に、Kubernetesクライアントkubectlを取得します。

  • 次に、KubernetesクライアントとvleaEnvを使用して、Appfileのレンダリングに必要なAppfileOptionsをビルドします。

  • 最後に、o.Run(filePath、velaEnv.Namespace、c)を呼び出します。
    • この関数には3つのパラメーターが必要です。そのうち、filePathはappfileの場所を指定するために使用され、velaEnv.Namespaceとcは指定された名前空間にレンダリングされたアプリケーションを作成するために使用されます。
      • filePath:appfileのパス
      • velaEnv.Namespace:K8の名前空間に対応
      • c:K8sクライアント

アプリファイルをKubernetesでアプリケーションに変換する方法

  • 開始点:appfile

  • 終了:アプリケーション

  • 路径:appfile->アプリケーション(サービス->コンポーネント)
    • comp [ワークロード、特性]

1.開始点:AppFile

// references/appfile/api/appfile.go
// AppFile defines the spec of KubeVela Appfile
type AppFile struct {
  Name       string             `json:"name"`
  CreateTime time.Time          `json:"createTime,omitempty"`
  UpdateTime time.Time          `json:"updateTime,omitempty"`
  Services   map[string]Service `json:"services"`
  Secrets    map[string]string  `json:"secrets,omitempty"`

  configGetter config.Store
  initialized  bool
}

// NewAppFile init an empty AppFile struct
func NewAppFile() *AppFile {
  return &AppFile{
    Services:     make(map[string]Service),
    Secrets:      make(map[string]string),
    configGetter: &config.Local{},
  }
}
// references/appfile/api/service.go
// Service defines the service spec for AppFile, it will contain all related information including OAM component, traits, source to image, etc...
type Service map[string]interface{}

上記の2つのコードは、クライアント側でのAppFileの宣言です。Velaは指定されたパスのyamlファイルを読み取り、それをAppFileに割り当てます。

// references/appfile/api/appfile.go
// LoadFromFile will read the file and load the AppFile struct
func LoadFromFile(filename string) (*AppFile, error) {
  b, err := ioutil.ReadFile(filepath.Clean(filename))
  if err != nil {
    return nil, err
  }
  af := NewAppFile()
  // Add JSON format appfile support
  ext := filepath.Ext(filename)
  switch ext {
  case ".yaml", ".yml":
    err = yaml.Unmarshal(b, af)
  case ".json":
    af, err = JSONToYaml(b, af)
  default:
    if json.Valid(b) {
      af, err = JSONToYaml(b, af)
    } else {
      err = yaml.Unmarshal(b, af)
    }
  }
  if err != nil {
    return nil, err
  }
  return af, nil
}

以下は、vela.yamlファイルを読み取った後にAppFileにロードされたデータです。

# vela.yaml
name: test
services:
  nginx:
    type: webservice
    image: nginx
    env:
    - name: NAME
      value: kubevela

    # svc trait
    svc:
      type: NodePort
      ports:
      - port: 80
        nodePort: 32017
Name: test
CreateTime: 0001-01-01 00:00:00 +0000 UTC
UpdateTime: 0001-01-01 00:00:00 +0000 UTC
Services: map[
             nginx: map[
               env: [map[name: NAME value: kubevela]] 
               image: nginx 
               svc: map[ports: [map[nodePort: 32017 port: 80]] type: NodePort] 
               type: webservice
            ]
          ]
Secrets    map[]
configGetter: 0x447abd0 
initialized: false

2.エンドポイント:アプリケーション

// apis/core.oam.dev/application_types.go
type Application struct {
  metav1.TypeMeta   `json:",inline"`
  metav1.ObjectMeta `json:"metadata,omitempty"`

  Spec   ApplicationSpec `json:"spec,omitempty"`
  Status AppStatus       `json:"status,omitempty"`
}

// ApplicationSpec is the spec of Application
type ApplicationSpec struct {
  Components []ApplicationComponent `json:"components"`

  // TODO(wonderflow): we should have application level scopes supported here

  // RolloutPlan is the details on how to rollout the resources
  // The controller simply replace the old resources with the new one if there is no rollout plan involved
  // +optional
  RolloutPlan *v1alpha1.RolloutPlan `json:"rolloutPlan,omitempty"`
}

上記のコードは、.vela / deploy.yaml(以下のコードを参照)と組み合わせたアプリケーションの宣言です。アプリケーションとしてAppFileをレンダリングすることは、主にAppFileのサービスをアプリケーションのコンポーネントに変換することであることがわかります。

# .vela/deploy.yaml
apiVersion: core.oam.dev/v1alpha2
kind: Application
metadata:
  creationTimestamp: null
  name: test
  namespace: default
spec:
  components:
  - name: nginx
    scopes:
      healthscopes.core.oam.dev: test-default-health
    settings:
      env:
      - name: NAME
        value: kubevela
      image: nginx
    traits:
    - name: svc
      properties:
        ports:
        - nodePort: 32017
          port: 80
        type: NodePort
    type: webservice
status: {}

3.パス:サービス->コンポーネント

上記のコンテンツを組み合わせると、AppfileをApplicationに変換することは、主にサービスをコンポーネントにレンダリングしていることがわかります。

// references/appfile/api/appfile.go
// BuildOAMApplication renders Appfile into Application, Scopes and other K8s Resources.
func (app *AppFile) BuildOAMApplication(env *types.EnvMeta, io cmdutil.IOStreams, tm template.Manager, silence bool) (*v1alpha2.Application, []oam.Object, error) {
  ...
  servApp := new(v1alpha2.Application)
  servApp.SetNamespace(env.Namespace)
  servApp.SetName(app.Name)
  servApp.Spec.Components = []v1alpha2.ApplicationComponent{}
  for serviceName, svc := range app.GetServices() {
    ...
    // 完成 Service 到 Component 的转化
    comp, err := svc.RenderServiceToApplicationComponent(tm, serviceName)
    if err != nil {
      return nil, nil, err
    }
    servApp.Spec.Components = append(servApp.Spec.Components, comp)
  }
  servApp.SetGroupVersionKind(v1alpha2.SchemeGroupVersion.WithKind("Application"))
  auxiliaryObjects = append(auxiliaryObjects, addDefaultHealthScopeToApplication(servApp))
  return servApp, auxiliaryObjects, nil
}

上記のコードは、velaがAppfileをアプリケーションコードに変換する場所です。その中で、comp、err:= svc.RenderServiceToApplicationComponent(tm、serviceName)は、サービスからコンポーネントへの変換を完了します。

// references/appfile/api/service.go
// RenderServiceToApplicationComponent render all capabilities of a service to CUE values to KubeVela Application.
func (s Service) RenderServiceToApplicationComponent(tm template.Manager, serviceName string) (v1alpha2.ApplicationComponent, error) {

  // sort out configs by workload/trait
  workloadKeys := map[string]interface{}{}
  var traits []v1alpha2.ApplicationTrait

  wtype := s.GetType()
  comp := v1alpha2.ApplicationComponent{
    Name:         serviceName,
    WorkloadType: wtype,
  }

  for k, v := range s.GetApplicationConfig() {
    // 判断是否为 trait
    if tm.IsTrait(k) {
      trait := v1alpha2.ApplicationTrait{
        Name: k,
      }
      ....
      // 如果是 triat 加入 traits 中
      traits = append(traits, trait)
      continue
    }
    workloadKeys[k] = v
  }

  // Handle workloadKeys to settings
  settings := &runtime.RawExte nsion{}
  pt, err := json.Marshal(workloadKeys)
  if err != nil {
    return comp, err
  }
  if err := settings.UnmarshalJSON(pt); err != nil {
    return comp, err
  }
  comp.Settings = *settings

  if len(traits) > 0 {
    comp.Traits = traits
  }

  return comp, nil
}

4.まとめ

vela upコマンドを実行し、appfileをApplicationとしてレンダリングし、データを.vela / deploy.yamlに書き込んで、K8sで作成します。

2.png

アプリケーションはどのように対応するK8sリソースオブジェクトに変換されますか

  • 開始点:アプリケーション
  • 中点:ApplicationConfiguration、Component
  • エンドポイント:展開、サービス
  • 道:
    • application_controller
    • applicationconfigurationコントローラー

[提案] >コンテンツについて学ぶ:>-client-to

  • コントローラ-ランタイム
  • オペレーター

1.アプリケーション

# 获取集群中的 Application
$ kubectl get application
NAMESPACE   NAME   AGE
default     test   24h

2.ApplicationConfiguration和コンポーネント

アプリケーションコントローラは、アプリケーションリソースオブジェクトを取得した後、その内容に基づいて対応するApplicationConfigurationとComponentを作成します。

# 获取 ApplicationConfiguration 和 Component
$ kubectl get ApplicationConfiguration,Component
NAME                                         AGE
applicationconfiguration.core.oam.dev/test   24h

NAME                           WORKLOAD-KIND   AGE
component.core.oam.dev/nginx   Deployment      24h

ApplicationiConfigurationに名前でコンポーネントをインポートします。

3.png

3.アプリケーションコントローラー

基本ロジック:
  • アプリケーションリソースオブジェクトを取得します。

  • アプリケーションリソースオブジェクトをApplicationConfigurationおよびComponentとしてレンダリングします。

  • ApplicationConfigurationおよびComponentリソースオブジェクトを作成します。
コード:
// pkg/controller/core.oam.dev/v1alpha2/application/application_controller.go

// Reconcile process app event
func (r *Reconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
  ctx := context.Background()
  applog := r.Log.WithValues("application", req.NamespacedName)

  // 1. 获取 Application
  app := new(v1alpha2.Application)
  if err := r.Get(ctx, client.ObjectKey{
    Name:      req.Name,
    Namespace: req.Namespace,
  }, app); err != nil {
    ...
  }

  ...

  // 2. 将 Application 转换为 ApplicationConfiguration 和 Component
  handler := &appHandler{r, app, applog}
  ...
  appParser := appfile.NewApplicationParser(r.Client, r.dm)
  ...
  appfile, err := appParser.GenerateAppFile(ctx, app.Name, app)
  ...
  ac, comps, err := appParser.GenerateApplicationConfiguration(appfile, app.Namespace)
  ...

  // 3. 在集群中创建 ApplicationConfiguration 和 Component 
  // apply appConfig & component to the cluster
  if err := handler.apply(ctx, ac, comps); err != nil {
    applog.Error(err, "[Handle apply]")
    app.Status.SetConditions(errorCondition("Applied", err))
    return handler.handleErr(err)
  }

  ...
  return ctrl.Result{}, r.UpdateStatus(ctx, app)
}

4.applicationconfigurationコントローラー

基本ロジック:
  • ApplicationConfigurationリソースオブジェクトを取得します。

  • ループスルーし、各コンポーネントを取得して、ワークロードとトレイトを対応するK8sリソースオブジェクトにレンダリングします。

  • 対応するK8sリソースオブジェクトを作成します。
コード:
// pkg/controller/core.oam.dev/v1alpha2/applicationcinfiguratioin/applicationconfiguratioin.go

// Reconcile an OAM ApplicationConfigurations by rendering and instantiating its
// Components and Traits.
func (r *OAMApplicationReconciler) Reconcile(req reconcile.Request) (reconcile.Result, error) {
  ...
  ac := &v1alpha2.ApplicationConfiguration{}
  // 1. 获取 ApplicationConfiguration
  if err := r.client.Get(ctx, req.NamespacedName, ac); err != nil {
    ...
  }
  return r.ACReconcile(ctx, ac, log)
}

// ACReconcile contains all the reconcile logic of an AC, it can be used by other controller
func (r *OAMApplicationReconciler) ACReconcile(ctx context.Context, ac *v1alpha2.ApplicationConfiguration,
  log logging.Logger) (result reconcile.Result, returnErr error) {

  ...
  // 2. 渲染
  // 此处 workloads 包含所有Component对应的的 workload 和 tratis 的 k8s 资源对象
  workloads, depStatus, err := r.components.Render(ctx, ac)
  ...

  applyOpts := []apply.ApplyOption{apply.MustBeControllableBy(ac.GetUID()), applyOnceOnly(ac, r.applyOnceOnlyMode, log)}

  // 3. 创建 workload 和 traits 对应的 k8s 资源对象
  if err := r.workloads.Apply(ctx, ac.Status.Workloads, workloads, applyOpts...); err != nil {
    ...
  }

  ...

  // the defer function will do the final status update
  return reconcile.Result{RequeueAfter: waitTime}, nil
}

5.まとめ

vela upがAppFileをアプリケーションとしてレンダリングすると、後続のプロセスはアプリケーションコントローラーとアプリケーション構成コントローラーによって完了します。

4.png

著者について

Dayong Fan、Teamsun TianchengのR&Dエンジニア、GitHub ID:@ just-do1。

OAMに参加する

おすすめ

転載: blog.51cto.com/13778063/2677650
おすすめ