github.com/x-helm/helm@v3.0.0-beta.3+incompatible/pkg/action/status.go (about)

     1  /*
     2  Copyright The Helm Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package action
    18  
    19  import (
    20  	"helm.sh/helm/pkg/release"
    21  )
    22  
    23  // Status is the action for checking the deployment status of releases.
    24  //
    25  // It provides the implementation of 'helm status'.
    26  type Status struct {
    27  	cfg *Configuration
    28  
    29  	Version      int
    30  	OutputFormat string
    31  }
    32  
    33  // NewStatus creates a new Status object with the given configuration.
    34  func NewStatus(cfg *Configuration) *Status {
    35  	return &Status{
    36  		cfg: cfg,
    37  	}
    38  }
    39  
    40  // Run executes 'helm status' against the given release.
    41  func (s *Status) Run(name string) (*release.Release, error) {
    42  	if err := s.cfg.KubeClient.IsReachable(); err != nil {
    43  		return nil, err
    44  	}
    45  
    46  	return s.cfg.releaseContent(name, s.Version)
    47  }