Merge pull request #5961 from oasisprotocol/peternose/feature/hot-loading

go/runtime: Support hot-loading of runtime bundles

Author: peternose

.changelog/5962.cfg.md

@@ -0,0 +1,28 @@
+go/runtime: Support hot-loading of runtime bundles
+
+The node can now fetch and verify runtime bundles from remote repositories
+and automatically update to new versions.
+
+The following configuration option has been removed:
+
+- `runtime.components`
+
+The following configuration option has been deprecated:
+
+- `runtime.config`
+
+The following configuration options have been added:
+
+- `runtime.runtimes.id` is the runtime identifier,
+
+- `runtime.runtimes.components` is the list of components to configure,
+
+- `runtime.runtimes.config` is the runtime local configuration,
+
+- `runtime.runtimes.repositories` is the list of runtime specific URLs
+   used to fetch runtime bundle metadata,
+
+- `runtime.repositories` is the list of global URLs used to fetch
+   runtime bundle metadata,
+
+- `runtime.max_bundle_size` is the maximum allowed bundle size.

go/common/version/version.go

@@ -39,6 +39,18 @@ func (v Version) ValidateBasic() error {
 	return nil
 }
 
+// Cmp returns a negative number when the given version is larger, a positive
+// number when smaller, and zero when both versions are equal.
+func (v Version) Cmp(other Version) int {
+	if v.Major != other.Major {
+		return int(v.Major) - int(other.Major)
+	}
+	if v.Minor != other.Minor {
+		return int(v.Minor) - int(other.Minor)
+	}
+	return int(v.Patch) - int(other.Patch)
+}
+
 // ToU64 returns the version as platform-dependent uint64.
 func (v Version) ToU64() uint64 {
 	return (uint64(v.Major) << 32) | (uint64(v.Minor) << 16) | (uint64(v.Patch))

go/control/api/api.go

@@ -11,11 +11,13 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/common/crypto/signature"
 	"github.com/oasisprotocol/oasis-core/go/common/errors"
 	"github.com/oasisprotocol/oasis-core/go/common/node"
+	"github.com/oasisprotocol/oasis-core/go/common/version"
 	"github.com/oasisprotocol/oasis-core/go/config"
 	consensus "github.com/oasisprotocol/oasis-core/go/consensus/api"
 	p2p "github.com/oasisprotocol/oasis-core/go/p2p/api"
 	registry "github.com/oasisprotocol/oasis-core/go/registry/api"
 	block "github.com/oasisprotocol/oasis-core/go/roothash/api/block"
+	"github.com/oasisprotocol/oasis-core/go/runtime/bundle/component"
 	storage "github.com/oasisprotocol/oasis-core/go/storage/api"
 	upgrade "github.com/oasisprotocol/oasis-core/go/upgrade/api"
 	commonWorker "github.com/oasisprotocol/oasis-core/go/worker/common/api"
@@ -85,6 +87,9 @@ type Status struct {
 	// Runtimes is the status overview for each runtime supported by the node.
 	Runtimes map[common.Namespace]RuntimeStatus `json:"runtimes,omitempty"`
 
+	// Bundles is the status overview of known runtime bundles.
+	Bundles []BundleStatus `json:"bundles,omitempty"`
+
 	// Registration is the node's registration status.
 	Registration *RegistrationStatus `json:"registration,omitempty"`
 
@@ -188,6 +193,37 @@ type RuntimeStatus struct {
 	Provisioner string `json:"provisioner,omitempty"`
 }
 
+// BundleStatus is the per-runtime bundle status overview.
+type BundleStatus struct {
+	// Name is the optional human readable runtime name.
+	Name string `json:"name,omitempty"`
+
+	// ID is the runtime identifier.
+	ID common.Namespace `json:"id"`
+
+	// Components contains statuses of the runtime components.
+	Components []ComponentStatus `json:"components,omitempty"`
+}
+
+// ComponentStatus is the component status overview.
+type ComponentStatus struct {
+	// Kind is the component kind.
+	Kind component.Kind `json:"kind"`
+
+	// Name is the name of the component.
+	Name string `json:"name,omitempty"`
+
+	// Version is the component version.
+	Version version.Version `json:"version,omitempty"`
+
+	// Detached specifies whether the component was in a detached bundle.
+	Detached bool `json:"detached,omitempty"`
+
+	// Disabled specifies whether the component is disabled by default
+	// and needs to be explicitly enabled via node configuration to be used.
+	Disabled bool `json:"disabled,omitempty"`
+}
+
 // SeedStatus is the status of the seed node.
 type SeedStatus struct {
 	// ChainContext is the chain domain separation context.

go/oasis-net-runner/fixtures/default.go

@@ -241,11 +241,11 @@ func newDefaultFixture() (*oasis.NetworkFixture, error) {
 				GovernanceModel: registry.GovernanceEntity,
 				Deployments: []oasis.DeploymentCfg{
 					{
-						Version:   rtVersion,
 						ValidFrom: 0,
 						Components: []oasis.ComponentCfg{
 							{
-								Kind: component.RONL,
+								Kind:    component.RONL,
+								Version: rtVersion,
 								Binaries: map[node.TEEHardware]string{
 									tee: rt,
 								},

go/oasis-node/cmd/node/flags.go

@@ -9,7 +9,7 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/flags"
 	cmdGrpc "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/grpc"
 	cmdSigner "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/signer"
-	runtimeRegistry "github.com/oasisprotocol/oasis-core/go/runtime/registry"
+	"github.com/oasisprotocol/oasis-core/go/runtime/bundle"
 	workerStorage "github.com/oasisprotocol/oasis-core/go/worker/storage"
 )
 
@@ -38,7 +38,7 @@ func init() {
 	for _, v := range []*flag.FlagSet{
 		cmdGrpc.ServerLocalFlags,
 		cmdSigner.Flags,
-		runtimeRegistry.Flags,
+		bundle.Flags,
 		workerStorage.Flags,
 		crash.InitFlags(),
 	} {

go/oasis-node/cmd/node/node.go

@@ -232,7 +232,7 @@ func (n *Node) initRuntimeWorkers() error {
 	if err != nil {
 		return err
 	}
-	n.svcMgr.RegisterCleanupOnly(n.RuntimeRegistry, "runtime registry")
+	n.svcMgr.Register(n.RuntimeRegistry)
 
 	// Initialize the common worker.
 	n.CommonWorker, err = workerCommon.New(
@@ -353,6 +353,11 @@ func (n *Node) initRuntimeWorkers() error {
 }
 
 func (n *Node) startRuntimeWorkers() error {
+	// Start the runtime registry.
+	if err := n.RuntimeRegistry.Start(); err != nil {
+		return err
+	}
+
 	// Start the common worker.
 	if err := n.CommonWorker.Start(); err != nil {
 		return err

go/oasis-node/cmd/node/node_control.go

@@ -135,6 +135,11 @@ func (n *Node) GetStatus(ctx context.Context) (*control.Status, error) {
 		return nil, fmt.Errorf("failed to get runtime status: %w", err)
 	}
 
+	bundles, err := n.getBundleStatus()
+	if err != nil {
+		return nil, fmt.Errorf("failed to get bundle status: %w", err)
+	}
+
 	kms, err := n.getKeymanagerStatus()
 	if err != nil {
 		return nil, fmt.Errorf("failed to get key manager worker status: %w", err)
@@ -165,6 +170,7 @@ func (n *Node) GetStatus(ctx context.Context) (*control.Status, error) {
 		Consensus:       cs,
 		LightClient:     lcs,
 		Runtimes:        runtimes,
+		Bundles:         bundles,
 		Keymanager:      kms,
 		Registration:    rs,
 		PendingUpgrades: pendingUpgrades,
@@ -199,6 +205,10 @@ func (n *Node) getRuntimeStatus(ctx context.Context) (map[common.Namespace]contr
 	runtimes := make(map[common.Namespace]control.RuntimeStatus)
 
 	for _, rt := range n.RuntimeRegistry.Runtimes() {
+		if !rt.IsManaged() {
+			continue
+		}
+
 		var status control.RuntimeStatus
 
 		// Fetch runtime registry descriptor. Do not wait too long for the descriptor to become
@@ -343,6 +353,41 @@ func (n *Node) getRuntimeStatus(ctx context.Context) (map[common.Namespace]contr
 	return runtimes, nil
 }
 
+func (n *Node) getBundleStatus() ([]control.BundleStatus, error) {
+	bundleRegistry := n.RuntimeRegistry.GetBundleRegistry()
+	manifests := bundleRegistry.GetManifests()
+	bundles := make([]control.BundleStatus, 0, len(manifests))
+
+	for _, manifest := range manifests {
+		explodedComponents, err := bundleRegistry.GetComponents(manifest.ID, manifest.GetVersion())
+		if err != nil {
+			return nil, err
+		}
+
+		components := make([]control.ComponentStatus, 0, len(explodedComponents))
+		for _, comp := range explodedComponents {
+			component := control.ComponentStatus{
+				Kind:     comp.Kind,
+				Name:     comp.Name,
+				Version:  comp.Version,
+				Detached: comp.Detached,
+				Disabled: comp.Disabled,
+			}
+			components = append(components, component)
+		}
+
+		bundle := control.BundleStatus{
+			Name:       manifest.Name,
+			ID:         manifest.ID,
+			Components: components,
+		}
+
+		bundles = append(bundles, bundle)
+	}
+
+	return bundles, nil
+}
+
 func (n *Node) getKeymanagerStatus() (*keymanagerWorker.Status, error) {
 	if n.KeymanagerWorker == nil || !n.KeymanagerWorker.Enabled() {
 		return nil, nil

go/oasis-node/cmd/storage/storage.go

@@ -17,6 +17,7 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/config"
 	cmdCommon "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common"
 	roothash "github.com/oasisprotocol/oasis-core/go/roothash/api"
+	"github.com/oasisprotocol/oasis-core/go/runtime/bundle"
 	"github.com/oasisprotocol/oasis-core/go/runtime/history"
 	"github.com/oasisprotocol/oasis-core/go/runtime/registry"
 	db "github.com/oasisprotocol/oasis-core/go/storage/mkvs/db/api"
@@ -284,8 +285,8 @@ func doRenameNs(_ *cobra.Command, args []string) error {
 
 // Register registers the client sub-command and all of its children.
 func Register(parentCmd *cobra.Command) {
-	storageMigrateCmd.Flags().AddFlagSet(registry.Flags)
-	storageCheckCmd.Flags().AddFlagSet(registry.Flags)
+	storageMigrateCmd.Flags().AddFlagSet(bundle.Flags)
+	storageCheckCmd.Flags().AddFlagSet(bundle.Flags)
 	storageCmd.AddCommand(storageMigrateCmd)
 	storageCmd.AddCommand(storageCheckCmd)
 	storageCmd.AddCommand(storageRenameNsCmd)

go/oasis-node/node_test.go

@@ -35,10 +35,10 @@ import (
 	registryTests "github.com/oasisprotocol/oasis-core/go/registry/tests"
 	roothash "github.com/oasisprotocol/oasis-core/go/roothash/api"
 	roothashTests "github.com/oasisprotocol/oasis-core/go/roothash/tests"
+	"github.com/oasisprotocol/oasis-core/go/runtime/bundle"
 	runtimeClient "github.com/oasisprotocol/oasis-core/go/runtime/client/api"
 	clientTests "github.com/oasisprotocol/oasis-core/go/runtime/client/tests"
 	runtimeConfig "github.com/oasisprotocol/oasis-core/go/runtime/config"
-	runtimeRegistry "github.com/oasisprotocol/oasis-core/go/runtime/registry"
 	scheduler "github.com/oasisprotocol/oasis-core/go/scheduler/api"
 	schedulerTests "github.com/oasisprotocol/oasis-core/go/scheduler/tests"
 	staking "github.com/oasisprotocol/oasis-core/go/staking/api"
@@ -164,7 +164,7 @@ func newTestNode(t *testing.T) *testNode {
 
 	config.GlobalConfig.Common.DataDir = dataDir
 	config.GlobalConfig.Common.Log.File = filepath.Join(dataDir, "test-node.log")
-	viper.Set(runtimeRegistry.CfgDebugMockIDs, []string{
+	viper.Set(bundle.CfgDebugMockIDs, []string{
 		testRuntimeID.String(),
 	})
 	for _, kv := range testNodeStaticConfig {

go/oasis-test-runner/oasis/keymanager.go

@@ -17,6 +17,7 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/oasis-test-runner/env"
 	registry "github.com/oasisprotocol/oasis-core/go/registry/api"
 	"github.com/oasisprotocol/oasis-core/go/runtime/bundle"
+	runtimeCfg "github.com/oasisprotocol/oasis-core/go/runtime/config"
 	runtimeConfig "github.com/oasisprotocol/oasis-core/go/runtime/config"
 	keymanagerConfig "github.com/oasisprotocol/oasis-core/go/worker/keymanager/config"
 )
@@ -296,7 +297,14 @@ func (km *Keymanager) ModifyConfig() error {
 	km.Config.Runtime.Provisioner = km.runtimeProvisioner
 	km.Config.Runtime.SGXLoader = km.net.cfg.RuntimeSGXLoaderBinary
 	km.Config.Runtime.AttestInterval = km.net.cfg.RuntimeAttestInterval
+
+	rtCfg := runtimeCfg.RuntimeConfig{
+		ID: km.runtime.cfgSave.id,
+	}
+
+	km.Config.Runtime.Runtimes = append(km.Config.Runtime.Runtimes, rtCfg)
 	km.Config.Runtime.Paths = append(km.Config.Runtime.Paths, km.runtime.BundlePaths()...)
+	km.Config.Runtime.Repositories = []string{fmt.Sprintf("http://127.0.0.1:%d", km.net.getProvisionedPort(netPortRepository))}
 
 	km.Config.Keymanager.RuntimeID = km.runtime.ID().String()
 	km.Config.Keymanager.PrivatePeerPubKeys = km.privatePeerPubKeys