Skip to content

Commit

Permalink
Fix typo (konpyutaika#385)
Browse files Browse the repository at this point in the history
  • Loading branch information
juldrixx authored Feb 5, 2024
1 parent 7495056 commit 211dc55
Show file tree
Hide file tree
Showing 539 changed files with 3,015 additions and 3,034 deletions.
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -524,9 +524,9 @@

### Fixed Bugs

- [PR #53](https://github.com/Orange-OpenSource/nifikop/pull/53) - **[Operator]** Upgrade k8s dependencies to match with new version requirement : [#52](https://github.com/Orange-OpenSource/nifikop/issues/52) [#51](https://github.com/Orange-OpenSource/nifikop/issues/51) [#33](https://github.com/Orange-OpenSource/nifikop/issues/33)
- [PR #53](https://github.com/Orange-OpenSource/nifikop/pull/53) - **[Operator]** Upgrade k8s dependencies to match with new version requirement: [#52](https://github.com/Orange-OpenSource/nifikop/issues/52) [#51](https://github.com/Orange-OpenSource/nifikop/issues/51) [#33](https://github.com/Orange-OpenSource/nifikop/issues/33)
- [PR #53](https://github.com/Orange-OpenSource/nifikop/pull/53) - **[Operator]** Fix the users used into Reader user group
- [PR #53](https://github.com/Orange-OpenSource/nifikop/pull/53) - **[Documentation]** Fix the chart version informations : [#51](https://github.com/Orange-OpenSource/nifikop/issues/51)
- [PR #53](https://github.com/Orange-OpenSource/nifikop/pull/53) - **[Documentation]** Fix the chart version informations: [#51](https://github.com/Orange-OpenSource/nifikop/issues/51)

## v0.4.2-alpha-release

Expand All @@ -537,7 +537,7 @@
- [PR #41](https://github.com/Orange-OpenSource/nifikop/pull/41) - **[Operator/NifiUser]** Manage NiFi's users into NiFi Cluster
- [PR #41](https://github.com/Orange-OpenSource/nifikop/pull/41) - **[Operator/NifiUserGroup]** Manage NiFi's user groups into NiFi Cluster
- [PR #41](https://github.com/Orange-OpenSource/nifikop/pull/41) - **[Operator]** Manage NiFi's access policies
- [PR #41](https://github.com/Orange-OpenSource/nifikop/pull/41) - **[Operator/NifiCluster]** Create three defaults groups : admins, readers, nodes
- [PR #41](https://github.com/Orange-OpenSource/nifikop/pull/41) - **[Operator/NifiCluster]** Create three defaults groups: admins, readers, nodes
- [PR #41](https://github.com/Orange-OpenSource/nifikop/pull/41) - **[Operator/NifiCluster]** Add pod disruption budget support

### Changed
Expand Down Expand Up @@ -637,7 +637,7 @@

### Changed

- [MR #9](https://github.com/Orange-OpenSource/nifikop/-/merge_requests/9) - Improve rolling upgrade : on ready pods, not just running
- [MR #9](https://github.com/Orange-OpenSource/nifikop/-/merge_requests/9) - Improve rolling upgrade: on ready pods, not just running
- [MR #9](https://github.com/Orange-OpenSource/nifikop/-/merge_requests/9) - Improve cluster task events filter
- [MR #9](https://github.com/Orange-OpenSource/nifikop/-/merge_requests/9) - Improve Helm publication removing the cache
- [MR #10](https://github.com/Orange-OpenSource/nifikop/-/merge_requests/10) - Move secure cluster configuration level (at Spec level)
Expand All @@ -659,7 +659,7 @@
- Implement pod management lifecycle
- Implement Graceful downscale pod lifecycle management
- Implement Graceful upscale pod lifecycle management
- Implement configuration lifecycle management for : nifi.properties, zookeeper.properties, state-management.xml, login-identity-providers.xml, logback.xml, bootstrap.conf, bootstrap-notification-services.xml
- Implement configuration lifecycle management for: nifi.properties, zookeeper.properties, state-management.xml, login-identity-providers.xml, logback.xml, bootstrap.conf, bootstrap-notification-services.xml
- Initiate documentations
- Implementation basic makefile for some actions (debug, build, deploy, run, push, unit-test)
- Create helm chart for operator
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ NiFiKop is Apache 2.0 licensed and accepts contributions via GitHub pull request
# Email and Chat

- Email: [nifikop][nifikop]
- Slack : [https://slack.konpytika.io](https://join.slack.com/t/konpytika/shared_invite/zt-14md072lv-Jr8mqYoeUrqzfZF~YGUpXA)
- Slack: [https://slack.konpytika.io](https://join.slack.com/t/konpytika/shared_invite/zt-14md072lv-Jr8mqYoeUrqzfZF~YGUpXA)

## Getting started

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ debug-pod-logs:

define debug_telepresence
export TELEPRESENCE_REGISTRY=$(TELEPRESENCE_REGISTRY) ; \
echo "execute : cat nifi-operator.env" ; \
echo "execute: cat nifi-operator.env" ; \
sudo mkdir -p /var/run/secrets/kubernetes.io ; \
tdep=$(shell kubectl get deployment -l app=nifikop -o jsonpath='{.items[0].metadata.name}') ; \
echo kubectl get deployment -l app=nifikop -o jsonpath='{.items[0].metadata.name}' ; \
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Some of the high-level capabilities and objectives of Apache NiFi include, and s
- the provisioning of secure NiFi clusters
- Advanced Dataflow and user management via CRD

Some of the roadmap features :
Some of the roadmap features:

- Monitoring via **Prometheus**
- Automatic reaction and self healing based on alerts (plugin system, with meaningful default alert plugins)
Expand Down
4 changes: 2 additions & 2 deletions api/v1/common_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ type AccessPolicy struct {
// action defines the kind of action that will be granted, could be "read" or "write"
Action AccessPolicyAction `json:"action"`
// +kubebuilder:validation:Enum={"/system","/flow","/controller","/parameter-context","/provenance","/restricted-components","/policies","/tenants","/site-to-site","/proxy","/counters","/","/operation","/provenance-data","/data","/policies","/data-transfer"}
// resource defines the kind of resource targeted by this access policies, please refer to the following page :
// resource defines the kind of resource targeted by this access policies, please refer to the following page:
// https://nifi.apache.org/docs/nifi-docs/html/administration-guide.html#access-policies
Resource AccessPolicyResource `json:"resource"`
// componentType is used if the type is "component", it's allow to define the kind of component on which is the
Expand Down Expand Up @@ -255,7 +255,7 @@ const (
const (
// PKIBackendCertManager invokes cert-manager for user certificate management.
PKIBackendCertManager PKIBackend = "cert-manager"
// TODO : Add vault
// TODO: Add vault
// PKIBackendVault invokes vault PKI for user certificate management
// PKIBackendVault PKIBackend = "vault".
)
Expand Down
10 changes: 5 additions & 5 deletions api/v1/nificluster_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ type NifiClusterSpec struct {
LdapConfiguration LdapConfiguration `json:"ldapConfiguration,omitempty"`
// NifiClusterTaskSpec specifies the configuration of the nifi cluster Tasks
NifiClusterTaskSpec NifiClusterTaskSpec `json:"nifiClusterTaskSpec,omitempty"`
// TODO : add vault
// TODO: add vault
// VaultConfig VaultConfig `json:"vaultConfig,omitempty"`
// listenerConfig specifies nifi's listener specifig configs
ListenersConfig *ListenersConfig `json:"listenersConfig,omitempty"`
Expand Down Expand Up @@ -410,7 +410,7 @@ type ListenersConfig struct {
// clusterDomain allow to override the default cluster domain which is "cluster.local"
ClusterDomain string `json:"clusterDomain,omitempty"`
// useExternalDNS allow to manage externalDNS usage by limiting the DNS names associated
// to each nodes and load balancer : <cluster-name>-node-<node Id>.<cluster-name>.<service name>.<cluster domain>
// to each nodes and load balancer: <cluster-name>-node-<node Id>.<cluster-name>.<service name>.<cluster domain>
UseExternalDNS bool `json:"useExternalDNS,omitempty"`
}

Expand All @@ -423,15 +423,15 @@ type SSLSecrets struct {
Create bool `json:"create,omitempty"`
// clusterScoped defines if the Issuer created is cluster or namespace scoped
ClusterScoped bool `json:"clusterScoped,omitempty"`
// issuerRef allow to use an existing issuer to act as CA :
// issuerRef allow to use an existing issuer to act as CA:
// https://cert-manager.io/docs/concepts/issuer/
IssuerRef *cmmeta.ObjectReference `json:"issuerRef,omitempty"`
// TODO : add vault
// TODO: add vault
PKIBackend PKIBackend `json:"pkiBackend,omitempty"`
// ,"vault"
}

// TODO : Add vault
// TODO: Add vault
// VaultConfig defines the configuration for a vault PKI backend
/*type VaultConfig struct {
//
Expand Down
2 changes: 1 addition & 1 deletion api/v1/nifidataflow_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type NifiDataflowSpec struct {
ClusterRef ClusterReference `json:"clusterRef,omitempty"`
// contains the reference to the NifiRegistry with the one the dataflow is linked.
RegistryClientRef *RegistryClientReference `json:"registryClientRef,omitempty"`
// describes the way the operator will deal with data when a dataflow will be updated : drop or drain
// describes the way the operator will deal with data when a dataflow will be updated: drop or drain
UpdateStrategy ComponentUpdateStrategy `json:"updateStrategy"`
}

Expand Down
4 changes: 2 additions & 2 deletions api/v1alpha1/common_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ type AccessPolicy struct {
// action defines the kind of action that will be granted, could be "read" or "write"
Action AccessPolicyAction `json:"action"`
// +kubebuilder:validation:Enum={"/system","/flow","/controller","/parameter-context","/provenance","/restricted-components","/policies","/tenants","/site-to-site","/proxy","/counters","/","/operation","/provenance-data","/data","/policies","/data-transfer"}
// resource defines the kind of resource targeted by this access policies, please refer to the following page :
// resource defines the kind of resource targeted by this access policies, please refer to the following page:
// https://nifi.apache.org/docs/nifi-docs/html/administration-guide.html#access-policies
Resource AccessPolicyResource `json:"resource"`
// componentType is used if the type is "component", it's allow to define the kind of component on which is the
Expand Down Expand Up @@ -260,7 +260,7 @@ const (
const (
// PKIBackendCertManager invokes cert-manager for user certificate management.
PKIBackendCertManager PKIBackend = "cert-manager"
// TODO : Add vault
// TODO: Add vault
// PKIBackendVault invokes vault PKI for user certificate management
// PKIBackendVault PKIBackend = "vault".
)
Expand Down
10 changes: 5 additions & 5 deletions api/v1alpha1/nificluster_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ type NifiClusterSpec struct {
LdapConfiguration LdapConfiguration `json:"ldapConfiguration,omitempty"`
// NifiClusterTaskSpec specifies the configuration of the nifi cluster Tasks
NifiClusterTaskSpec NifiClusterTaskSpec `json:"nifiClusterTaskSpec,omitempty"`
// TODO : add vault
// TODO: add vault
// VaultConfig VaultConfig `json:"vaultConfig,omitempty"`
// listenerConfig specifies nifi's listener specifig configs
ListenersConfig *ListenersConfig `json:"listenersConfig,omitempty"`
Expand Down Expand Up @@ -354,7 +354,7 @@ type ListenersConfig struct {
// clusterDomain allow to override the default cluster domain which is "cluster.local"
ClusterDomain string `json:"clusterDomain,omitempty"`
// useExternalDNS allow to manage externalDNS usage by limiting the DNS names associated
// to each nodes and load balancer : <cluster-name>-node-<node Id>.<cluster-name>.<service name>.<cluster domain>
// to each nodes and load balancer: <cluster-name>-node-<node Id>.<cluster-name>.<service name>.<cluster domain>
UseExternalDNS bool `json:"useExternalDNS,omitempty"`
}

Expand All @@ -367,15 +367,15 @@ type SSLSecrets struct {
Create bool `json:"create,omitempty"`
// clusterScoped defines if the Issuer created is cluster or namespace scoped
ClusterScoped bool `json:"clusterScoped,omitempty"`
// issuerRef allow to use an existing issuer to act as CA :
// issuerRef allow to use an existing issuer to act as CA:
// https://cert-manager.io/docs/concepts/issuer/
IssuerRef *cmmeta.ObjectReference `json:"issuerRef,omitempty"`
// TODO : add vault
// TODO: add vault
PKIBackend PKIBackend `json:"pkiBackend,omitempty"`
// ,"vault"
}

// TODO : Add vault
// TODO: Add vault
// VaultConfig defines the configuration for a vault PKI backend
/*type VaultConfig struct {
//
Expand Down
2 changes: 1 addition & 1 deletion api/v1alpha1/nificonnection_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ type NifiConnectionSpec struct {
Destination ComponentReference `json:"destination"`
// the Configuration of the connection.
Configuration ConnectionConfiguration `json:"configuration,omitempty"`
// describes the way the operator will deal with data when a connection will be updated : drop or drain.
// describes the way the operator will deal with data when a connection will be updated: drop or drain.
UpdateStrategy v1.ComponentUpdateStrategy `json:"updateStrategy"`
}

Expand Down
2 changes: 1 addition & 1 deletion api/v1alpha1/nifidataflow_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ type NifiDataflowSpec struct {
ClusterRef ClusterReference `json:"clusterRef,omitempty"`
// contains the reference to the NifiRegistry with the one the dataflow is linked.
RegistryClientRef *RegistryClientReference `json:"registryClientRef,omitempty"`
// describes the way the operator will deal with data when a dataflow will be updated : drop or drain
// describes the way the operator will deal with data when a dataflow will be updated: drop or drain
UpdateStrategy ComponentUpdateStrategy `json:"updateStrategy"`
}

Expand Down
6 changes: 3 additions & 3 deletions config/samples/nifi_v1_nificluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ spec:
#
propagateLabels: true
# managedAdminUsers:
# - identity : "[email protected]"
# - identity: "[email protected]"
# name: "aguitton"
# managedReaderUsers:
# - identity : "[email protected]"
# - identity: "[email protected]"
# name: "toto"
# readOnlyConfig specifies the read-only type Nifi config cluster wide, all theses
# will be merged with node specified readOnly configurations, so it can be overwritten per node.
Expand Down Expand Up @@ -346,7 +346,7 @@ spec:
# create: true
# clusterScoped defines if the Issuer created is cluster or namespace scoped
# clusterScoped: false
# issuerRef allow to use an existing issuer to act as CA :
# issuerRef allow to use an existing issuer to act as CA:
# https://cert-manager.io/docs/concepts/issuer/
# issuerRef:
# name: letsencrypt-staging
Expand Down
2 changes: 1 addition & 1 deletion config/samples/nifi_v1_nifidataflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ spec:
parameterContextRef:
name: dataflow-lifecycle
namespace: nifikop
# describes the way the operator will deal with data when a dataflow will be updated : drop or drain
# describes the way the operator will deal with data when a dataflow will be updated: drop or drain
updateStrategy: drain
2 changes: 1 addition & 1 deletion config/samples/nifi_v1_nifiuser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ spec:
# - type: component
# # defines the kind of action that will be granted, could be "read" or "write"
# action: read
# # resource defines the kind of resource targeted by this access policies, please refer to the following page :
# # resource defines the kind of resource targeted by this access policies, please refer to the following page:
# # https://nifi.apache.org/docs/nifi-docs/html/administration-guide.html#access-policies
# resource: /counters
# # componentType is used if the type is "component", it's allow to define the kind of component on which is the
Expand Down
4 changes: 2 additions & 2 deletions config/samples/nifi_v1_nifiusergroup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ spec:
# contains the list of reference to NifiUsers that are part to the group.
usersRef:
- name: nc-0-node.nc-headless.nifikop.svc.cluster.local
# namespace: nifikop
# namespace: nifikop
- name: nc-controller.nifikop.mgt.cluster.local
# defines the list of access policies that will be granted to the group.
accessPolicies:
# defines the kind of access policy, could be "global" or "component".
- type: global
# defines the kind of action that will be granted, could be "read" or "write"
action: read
# resource defines the kind of resource targeted by this access policies, please refer to the following page :
# resource defines the kind of resource targeted by this access policies, please refer to the following page:
# https://nifi.apache.org/docs/nifi-docs/html/administration-guide.html#access-policies
resource: /counters
# # componentType is used if the type is "component", it's allow to define the kind of component on which is the
Expand Down
2 changes: 1 addition & 1 deletion config/samples/nifi_v1alpha1_nificonnection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ spec:
posY: 440
- posX: 550
posY: 88
# describes the way the operator will deal with data when a connection will be updated : drop or drain.
# describes the way the operator will deal with data when a connection will be updated: drop or drain.
updateStrategy: drain
4 changes: 2 additions & 2 deletions config/samples/tls_secured_nificluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ spec:
clusterImage: "apache/nifi:1.17.0"
oneNifiNodePerNode: false
managedAdminUsers:
- identity : "[email protected]"
- identity: "[email protected]"
name: "aguitton"
managedReaderUsers:
- identity : "[email protected]"
- identity: "[email protected]"
name: "toto"
propagateLabels: true
nifiClusterTaskSpec:
Expand Down
4 changes: 2 additions & 2 deletions controllers/nificlustertask_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -314,12 +314,12 @@ func (r *NifiClusterTaskReconciler) handlePodRunningTask(nifiCluster *v1.NifiClu
}
}

// TODO : Investigate workaround used because of error :
// TODO: Investigate workaround used because of error :
// 2020-02-18 08:30:07,850 INFO [Process Cluster Protocol Request-4] o.a.n.c.c.node.NodeClusterCoordinator Status of nifi-12-node.nifi-headless.nifi-demo.svc.cluster.local:8080
// changed from null to NodeConnectionStatus[nodeId=nifi-12-node.nifi-headless.nifi-demo.svc.cluster.local:8080, state=DISCONNECTED, Disconnect Code=Node was Shutdown,
// Disconnect Reason=Node was Shutdown, updateId=33]
// If pod finished deletion
// TODO : work here to manage node Status and state (If disconnected && Removing)
// TODO: work here to manage node Status and state (If disconnected && Removing)
if nifiCluster.Status.NodesState[nodeId].GracefulActionState.ActionStep == v1.RemovePodStatus {
actionStep, taskStartTime, err := scale.RemoveClusterNode(clientConfig, nodeId)
if err != nil {
Expand Down
Loading

0 comments on commit 211dc55

Please sign in to comment.