-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: enable streaming exec output in container engine [stream exec p…
…t. 1] (#1043) ## Description: Enables streaming output of exec commands out of docker and k8s as they are being run on services. ## Is this change user facing? NOT THIS PR (but stream exec pt. 2 will be)
- Loading branch information
Showing
10 changed files
with
499 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
...docker_kurtosis_backend/user_services_functions/run_user_service_exec_command_streamed.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
package user_service_functions | ||
|
||
import ( | ||
"context" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_impls/docker/docker_kurtosis_backend/shared_helpers" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_impls/docker/docker_manager" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/enclave" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/exec_result" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/service" | ||
"github.com/kurtosis-tech/stacktrace" | ||
) | ||
|
||
func RunUserServiceExecCommandWithStreamedOutput( | ||
ctx context.Context, | ||
enclaveId enclave.EnclaveUUID, | ||
serviceUuid service.ServiceUUID, | ||
cmd []string, | ||
dockerManager *docker_manager.DockerManager, | ||
) (chan string, chan *exec_result.ExecResult, error) { | ||
userServiceUuids := map[service.ServiceUUID]bool{} | ||
userServiceUuids[serviceUuid] = true | ||
filters := &service.ServiceFilters{ | ||
Names: nil, | ||
UUIDs: userServiceUuids, | ||
Statuses: nil, | ||
} | ||
_, allDockerResources, err := shared_helpers.GetMatchingUserServiceObjsAndDockerResourcesNoMutex(ctx, enclaveId, filters, dockerManager) | ||
if err != nil { | ||
return nil, nil, stacktrace.Propagate(err, "An error occurred getting user services matching filters '%+v'", filters) | ||
} | ||
|
||
var userServiceDockerResource *shared_helpers.UserServiceDockerResources | ||
if dockerResource, found := allDockerResources[serviceUuid]; found { | ||
userServiceDockerResource = dockerResource | ||
} else { | ||
return nil, nil, stacktrace.NewError("No docker resources were found for the service with identifier: '%v'", serviceUuid) | ||
} | ||
|
||
userServiceDockerContainer := userServiceDockerResource.ServiceContainer | ||
|
||
execOutputLinesChan, finalExecChan, err := dockerManager.RunExecCommandWithStreamedOutput( | ||
ctx, | ||
userServiceDockerContainer.GetId(), | ||
cmd) | ||
if err != nil { | ||
return nil, nil, stacktrace.Propagate(err, "An error occurred attempting to stream exec output from docker.") | ||
} | ||
|
||
return execOutputLinesChan, finalExecChan, nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
...rnetes_kurtosis_backend/user_services_functions/run_user_service_exec_command_streamed.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
package user_services_functions | ||
|
||
import ( | ||
"context" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_impls/kubernetes/kubernetes_kurtosis_backend/shared_helpers" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_impls/kubernetes/kubernetes_manager" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/container_status" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/enclave" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/exec_result" | ||
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/service" | ||
"github.com/kurtosis-tech/stacktrace" | ||
) | ||
|
||
func RunUserServiceExecCommandWithStreamedOutput( | ||
ctx context.Context, | ||
enclaveId enclave.EnclaveUUID, | ||
serviceUuid service.ServiceUUID, | ||
cmd []string, | ||
cliModeArgs *shared_helpers.CliModeArgs, | ||
apiContainerModeArgs *shared_helpers.ApiContainerModeArgs, | ||
engineServerModeArgs *shared_helpers.EngineServerModeArgs, | ||
kubernetesManager *kubernetes_manager.KubernetesManager, | ||
) (chan string, chan *exec_result.ExecResult, error) { | ||
namespaceName, err := shared_helpers.GetEnclaveNamespaceName(ctx, enclaveId, cliModeArgs, apiContainerModeArgs, engineServerModeArgs, kubernetesManager) | ||
if err != nil { | ||
return nil, nil, stacktrace.Propagate(err, "An error occurred getting namespace name for enclave '%v'", enclaveId) | ||
} | ||
|
||
requestedGuids := map[service.ServiceUUID]bool{} | ||
requestedGuids[serviceUuid] = true | ||
matchingServicesFilters := &service.ServiceFilters{ | ||
Names: nil, | ||
UUIDs: requestedGuids, | ||
Statuses: nil, | ||
} | ||
matchingObjectsAndResources, err := shared_helpers.GetMatchingUserServiceObjectsAndKubernetesResources(ctx, enclaveId, matchingServicesFilters, cliModeArgs, apiContainerModeArgs, engineServerModeArgs, kubernetesManager) | ||
if err != nil { | ||
return nil, nil, stacktrace.Propagate(err, "An error occurred getting user services matching the requested UUIDs: %v", requestedGuids) | ||
} | ||
|
||
var userServiceKubernetesResource *shared_helpers.UserServiceObjectsAndKubernetesResources | ||
if resource, found := matchingObjectsAndResources[serviceUuid]; found { | ||
userServiceKubernetesResource = resource | ||
} else { | ||
return nil, nil, stacktrace.NewError( | ||
"Cannot execute command '%+v' on service '%v' because no Kubernetes resources were found for it", | ||
cmd, | ||
serviceUuid) | ||
} | ||
|
||
userServiceKubernetesService := userServiceKubernetesResource.Service | ||
if userServiceKubernetesService == nil { | ||
return nil, nil, stacktrace.Propagate(err, "An error was found while running exec with streamed output over kubernetes for service '%s' and command '%v'.", | ||
cmd, | ||
serviceUuid) | ||
} | ||
if userServiceKubernetesService.GetStatus() != container_status.ContainerStatus_Running { | ||
return nil, nil, stacktrace.NewError( | ||
"Cannot execute command '%+v' on service '%v' because the service status is '%v'", | ||
cmd, | ||
serviceUuid, | ||
userServiceKubernetesService.GetStatus().String()) | ||
} | ||
|
||
userServiceKubernetesPod := userServiceKubernetesResource.KubernetesResources.Pod | ||
|
||
execOutputLinesChan, finalResultChan, err := kubernetesManager.RunExecCommandWithStreamedOutput( | ||
ctx, | ||
namespaceName, | ||
userServiceKubernetesPod.Name, | ||
userServiceContainerName, | ||
cmd) | ||
if err != nil { | ||
return nil, nil, stacktrace.Propagate(err, "An error occurred attempting to stream exec output from docker.") | ||
} | ||
return execOutputLinesChan, finalResultChan, nil | ||
} |
Oops, something went wrong.