Skip to content

Commit

Permalink
Updated descriptions and fixed some typos
Browse files Browse the repository at this point in the history 
Signed-off-by: Aayush Chouhan <[email protected]>
  • Loading branch information
@achouhan09
achouhan09 committed May 22, 2024
1 parent 3e74fe8 commit 8529a91
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 34 deletions.
20 changes: 9 additions & 11 deletions deploy/crds/noobaa.io_noobaas.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -977,22 +977,20 @@ spec:
type: string
type: object
bucketLogging:
description: |-
BucketLogging sets the configuration for bucket logging.
This configuration includes details such as the logging type (guaranteed or non-guaranteed),
and other relevant logging settings.
If not specified, the default logging configuration will be used.
description: BucketLogging sets the configuration for bucket logging
properties:
bucketclass:
description: TODO
bucketLoggingStorageClass:
description: |-
BucketLoggingStorageClass (otional) specifies the type of storage class that will be used to create a
PVC(Persistent Volume Claim) for guaranteed logging, if enabled.
type: string
loggingType:
description: |-
LoggingType specifies the type of logging for the bucket.
There are two types available: guaranteed and non-guaranteed logging.
- guaranteed logging ensures that all log entries are recorded without fail.
LoggingType specifies the type of logging for the bucket
There are two types available: guaranteed and non-guaranteed logging
- guaranteed logging ensures that all log entries are recorded without fail
- non-guaranteed logging may not record all log entries
By default, guaranteed logging is enabled if no type is specified.
By default, non-guaranteed logging is enabled if no type is specified
type: string
type: object
cleanupPolicy:
Expand Down
20 changes: 10 additions & 10 deletions pkg/apis/noobaa/v1alpha1/noobaa_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,10 +224,7 @@ type NooBaaSpec struct {
// +optional
DenyHTTP bool `json:"denyHTTP,omitempty"`

// BucketLogging sets the configuration for bucket logging.
// This configuration includes details such as the logging type (guaranteed or non-guaranteed),
// and other relevant logging settings.
// If not specified, the default logging configuration will be used.
// BucketLogging sets the configuration for bucket logging
// +optional
BucketLogging BucketLoggingSpec `json:"bucketLogging,omitempty"`
}
Expand All @@ -244,18 +241,20 @@ type AutoscalerSpec struct {
PrometheusNamespace string `json:"prometheusNamespace,omitempty"`
}

// BucetLoggingSpec defines the configuration for the bucket

Check failure on line 244 in pkg/apis/noobaa/v1alpha1/noobaa_types.go

View workflow job for this annotation

GitHub Actions / run-tests 

comment on exported type BucketLoggingSpec should be of the form "BucketLoggingSpec ..." (with optional leading article)
type BucketLoggingSpec struct {
// LoggingType specifies the type of logging for the bucket.
// There are two types available: guaranteed and non-guaranteed logging.
// - guaranteed logging ensures that all log entries are recorded without fail.
// LoggingType specifies the type of logging for the bucket
// There are two types available: guaranteed and non-guaranteed logging
// - guaranteed logging ensures that all log entries are recorded without fail
// - non-guaranteed logging may not record all log entries
// By default, guaranteed logging is enabled if no type is specified.
// By default, non-guaranteed logging is enabled if no type is specified
// +optional
LoggingType BucketLoggingTypes `json:"loggingType,omitempty"`

// TODO
// BucketLoggingStorageClass (otional) specifies the type of storage class that will be used to create a
// PVC(Persistent Volume Claim) for guaranteed logging, if enabled.
// +optional
BucketClass string `json:"bucketclass,omitempty"`
BucketLoggingStorageClass *string `json:"bucketLoggingStorageClass,omitempty"`
}

// LoadBalancerSourceSubnetSpec defines the subnets that will be allowed to access the NooBaa services
Expand Down Expand Up @@ -561,6 +560,7 @@ const (
AutoscalerTypeHPAV2 AutoscalerTypes = "hpav2"
)

// BucketLoggingTypes is a string enum type for specifying the types of bucketlogging supported.
type BucketLoggingTypes string

// These are the valid BucketLoggingTypes types:
Expand Down
7 changes: 6 additions & 1 deletion pkg/apis/noobaa/v1alpha1/zz_generated.deepcopy.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 10 additions & 12 deletions pkg/bundle/deploy.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1483,7 +1483,7 @@ spec:
status: {}
`

const Sha256_deploy_crds_noobaa_io_noobaas_yaml = "f364902b08bc66030e2766a311d765c87e2078895fa70dc432e285657d79f90c"
const Sha256_deploy_crds_noobaa_io_noobaas_yaml = "5694859015599e2a0ec2af19249fb4677fd0060ef3c1cb7e706754d7de640ed6"

const File_deploy_crds_noobaa_io_noobaas_yaml = `---
apiVersion: apiextensions.k8s.io/v1
Expand Down Expand Up @@ -2464,22 +2464,20 @@ spec:
type: string
type: object
bucketLogging:
description: |-
BucketLogging sets the configuration for bucket logging.
This configuration includes details such as the logging type (guaranteed or non-guaranteed),
and other relevant logging settings.
If not specified, the default logging configuration will be used.
description: BucketLogging sets the configuration for bucket logging
properties:
bucketclass:
description: TODO
bucketLoggingStorageClass:
description: |-
BucketLoggingStorageClass (otional) specifies the type of storage class that will be used to create a
PVC(Persistent Volume Claim) for guaranteed logging, if enabled.
type: string
loggingType:
description: |-
LoggingType specifies the type of logging for the bucket.
There are two types available: guaranteed and non-guaranteed logging.
- guaranteed logging ensures that all log entries are recorded without fail.
LoggingType specifies the type of logging for the bucket
There are two types available: guaranteed and non-guaranteed logging
- guaranteed logging ensures that all log entries are recorded without fail
- non-guaranteed logging may not record all log entries
By default, guaranteed logging is enabled if no type is specified.
By default, non-guaranteed logging is enabled if no type is specified
type: string
type: object
cleanupPolicy:
Expand Down

0 comments on commit 8529a91

Please sign in to comment.