chore(traits): deprecate registry

apache · Mar 6, 2024 · a3a542d · a3a542d
1 parent 825f0ce
commit a3a542d
Show file tree

Hide file tree

Showing 21 changed files with 66 additions and 74 deletions.
diff --git a/docs/modules/ROOT/pages/cli/cli.adoc b/docs/modules/ROOT/pages/cli/cli.adoc
@@ -124,17 +124,3 @@ $ kamel <command> --help
 
 Some command options in the CLI can be also specified as modeline in the source file, take a look at the xref:cli/modeline.adoc[Modeline] section
 for more information.
-
-[[image-registry]]
-== Image Registry
-
-The CLI can be used to xref:configuration/dependencies.adoc#local-remote-dependencies[upload] Maven dependencies and user data to the Image Registry. To do so, the CLI and the Operator have to be configured correctly.
-
-For the Operator part, have a look at the xref:installation/registry/registry.adoc[installation] documentation.
-
-For the CLI, in most cases, executing `docker login REGISTRY_URL` successfully will suffice.
-If the Image Registry uses a custom certificate authority then it needs to be trusted, see
-link:https://go.dev/src/crypto/x509/root_unix.go[SSL_CERT_FILE].
-
-
-
diff --git a/docs/modules/ROOT/pages/configuration/dependencies.adoc b/docs/modules/ROOT/pages/configuration/dependencies.adoc
@@ -74,37 +74,6 @@ kamel run -d mvn:com.google.guava:guava:26.0-jre Integration.java
 ```
 Note that if your dependencies belong to a private repository, this repository needs to be defined. See xref:installation/advanced/maven.adoc[Configure maven].
 
-[[local-remote-dependencies]]
-=== Local and remote dependencies
-
-*Local dependencies* can be added using the `-d` flag and the `file://` prefix:
-```
-kamel run -d file://path/to/integration-dep.jar Integration.java
-```
-
-You can also specify data files and directories which will be mounted in the running container relative to the working directory:
-
-```
-kamel run -d file://path/to/data.csv?targetPath=/in/container/data.csv Integration.java
-```
-
-If the data files needs to be present at build time, you can also set `classpath` option to `true`:
-
-```
-kamel run -d file://path/to/data.csv?targetPath=/in/container/data.csv&classpath=true Integration.java
-```
-
-Similarly, *remote dependencies* can be added with the `http(s)://` prefix:
-
-```
-kamel run -d https://raw.githubusercontent.com/example/data.csv|targetPath=/tmp/foo&classpath=true Integration.java
-```
-
-For a full list of options checkout `kamel run --help`.
-
-
-*Important note*: this will upload the dependencies and data files to the Image Registry. The CLI  and Operator need to be setup xref:cli/cli.adoc[correctly], especially if authentication or custom certificates are required.
-
 [[dependencies-kind-jitpack]]
 === Jitpack dependencies
 

diff --git a/docs/modules/ROOT/partials/apis/camel-k-crds.adoc b/docs/modules/ROOT/partials/apis/camel-k-crds.adoc
@@ -2655,6 +2655,7 @@ NOTE: Compiling to a native executable, requires at least 4GiB of memory, so the
 |
 
 
+Deprecated: use jvm trait or read documentation.
 The Registry trait sets up Maven to use the Image registry as a Maven repository.
 
 |`addons` +
@@ -5883,6 +5884,7 @@ The configuration of Quarkus trait
 |
 
 
+Deprecated: use jvm trait or read documentation.
 The configuration of Registry trait
 
 |`route` +
@@ -8173,6 +8175,8 @@ Deprecated: for backward compatibility.
 * <<#_camel_apache_org_v1_IntegrationKitTraits, IntegrationKitTraits>>
 * <<#_camel_apache_org_v1_Traits, Traits>>
 
+WARNING: The Tracing trait is **deprecated** and will removed in future release versions.
+
 The Registry trait sets up Maven to use the Image registry
 as a Maven repository.
 

diff --git a/docs/modules/traits/pages/registry.adoc b/docs/modules/traits/pages/registry.adoc
@@ -1,6 +1,8 @@
 = Registry Trait
 
 // Start of autogenerated code - DO NOT EDIT! (description)
+WARNING: The Tracing trait is **deprecated** and will removed in future release versions.
+
 The Registry trait sets up Maven to use the Image registry
 as a Maven repository.
 

diff --git a/helm/camel-k/crds/crd-integration-kit.yaml b/helm/camel-k/crds/crd-integration-kit.yaml
@@ -402,8 +402,9 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The Registry trait sets up Maven to use the Image
-                      registry as a Maven repository.
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The Registry trait sets up Maven to use the Image registry as
+                      a Maven repository.'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -755,8 +756,9 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The Registry trait sets up Maven to use the Image
-                      registry as a Maven repository.
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The Registry trait sets up Maven to use the Image registry as
+                      a Maven repository.'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/helm/camel-k/crds/crd-integration-platform.yaml b/helm/camel-k/crds/crd-integration-platform.yaml
@@ -1718,7 +1718,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -3600,7 +3601,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/helm/camel-k/crds/crd-integration-profile.yaml b/helm/camel-k/crds/crd-integration-profile.yaml
@@ -1600,7 +1600,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -3371,7 +3372,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/helm/camel-k/crds/crd-integration.yaml b/helm/camel-k/crds/crd-integration.yaml
@@ -7619,7 +7619,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -9348,7 +9349,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/helm/camel-k/crds/crd-kamelet-binding.yaml b/helm/camel-k/crds/crd-kamelet-binding.yaml
@@ -7921,7 +7921,8 @@ spec:
                             type: array
                         type: object
                       registry:
-                        description: The configuration of Registry trait
+                        description: 'Deprecated: use jvm trait or read documentation.
+                          The configuration of Registry trait'
                         properties:
                           configuration:
                             description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/helm/camel-k/crds/crd-pipe.yaml b/helm/camel-k/crds/crd-pipe.yaml
@@ -7919,7 +7919,8 @@ spec:
                             type: array
                         type: object
                       registry:
-                        description: The configuration of Registry trait
+                        description: 'Deprecated: use jvm trait or read documentation.
+                          The configuration of Registry trait'
                         properties:
                           configuration:
                             description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/pkg/apis/camel/v1/common_types.go b/pkg/apis/camel/v1/common_types.go
@@ -231,6 +231,7 @@ type Traits struct {
 	PullSecret *trait.PullSecretTrait `property:"pull-secret" json:"pull-secret,omitempty"`
 	// The configuration of Quarkus trait
 	Quarkus *trait.QuarkusTrait `property:"quarkus" json:"quarkus,omitempty"`
+	// Deprecated: use jvm trait or read documentation.
 	// The configuration of Registry trait
 	Registry *trait.RegistryTrait `property:"registry" json:"registry,omitempty"`
 	// The configuration of Route trait

diff --git a/pkg/apis/camel/v1/integrationkit_types.go b/pkg/apis/camel/v1/integrationkit_types.go
@@ -86,6 +86,7 @@ type IntegrationKitTraits struct {
 	// It's enabled by default.
 	// NOTE: Compiling to a native executable, requires at least 4GiB of memory, so the Pod running the native build must have enough memory available.
 	Quarkus *trait.QuarkusTrait `property:"quarkus" json:"quarkus,omitempty"`
+	// Deprecated: use jvm trait or read documentation.
 	// The Registry trait sets up Maven to use the Image registry as a Maven repository.
 	Registry *trait.RegistryTrait `property:"registry" json:"registry,omitempty"`
 	// The collection of addon trait configurations

diff --git a/pkg/apis/camel/v1/trait/registry.go b/pkg/apis/camel/v1/trait/registry.go
@@ -17,6 +17,8 @@ limitations under the License.
 
 package trait
 
+// WARNING: The Tracing trait is **deprecated** and will removed in future release versions.
+//
 // The Registry trait sets up Maven to use the Image registry
 // as a Maven repository.
 //

diff --git a/pkg/cmd/run.go b/pkg/cmd/run.go
@@ -76,8 +76,6 @@ import (
 	"github.com/apache/camel-k/v2/pkg/util/watch"
 )
 
-const usageDependency = `A dependency that should be included, e.g., "-d camel:mail" for a Camel component, "-d mvn:org.my:app:1.0" for a Maven dependency, "-d http(s)://my-repo/my-dependency.jar|targetPath=<path>&registry=<registry_URL>&skipChecksums=<true>&skipPOM=<true>&classpath=<true>" for custom dependencies located on an http server or "file://localPath[?targetPath=<path>&registry=<registry_URL>&skipChecksums=<true>&skipPOM=<true>&classpath=<true>]" for local files`
-
 func newCmdRun(rootCmdOptions *RootCmdOptions) (*cobra.Command, *runCmdOptions) {
 	options := runCmdOptions{
 		RootCmdOptions: rootCmdOptions,
@@ -98,7 +96,7 @@ func newCmdRun(rootCmdOptions *RootCmdOptions) (*cobra.Command, *runCmdOptions)
 	cmd.Flags().String("name", "", "The integration name")
 	cmd.Flags().String("image", "", "An image built externally (ie, via CICD). Enabling it will skip the Integration build phase.")
 	cmd.Flags().StringArrayP("connect", "c", nil, "A Service that the integration should bind to, specified as [[apigroup/]version:]kind:[namespace/]name")
-	cmd.Flags().StringArrayP("dependency", "d", nil, usageDependency)
+	cmd.Flags().StringArrayP("dependency", "d", nil, `A dependency that should be included, e.g., "-d camel:mail" for a Camel component, "-d mvn:org.my:app:1.0" for a Maven dependency`)
 	cmd.Flags().BoolP("wait", "w", false, "Wait for the integration to be running")
 	cmd.Flags().StringP("kit", "k", "", "The kit used to run the integration")
 	cmd.Flags().StringArrayP("property", "p", nil, "Add a runtime property or properties file from a path, a config map or a secret (syntax: [my-key=my-value|file:/path/to/my-conf.properties|[configmap|secret]:name])")

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationkits.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationkits.yaml
@@ -402,8 +402,9 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The Registry trait sets up Maven to use the Image
-                      registry as a Maven repository.
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The Registry trait sets up Maven to use the Image registry as
+                      a Maven repository.'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -755,8 +756,9 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The Registry trait sets up Maven to use the Image
-                      registry as a Maven repository.
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The Registry trait sets up Maven to use the Image registry as
+                      a Maven repository.'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml
@@ -1718,7 +1718,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -3600,7 +3601,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml
@@ -1600,7 +1600,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -3371,7 +3372,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml
@@ -7619,7 +7619,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:
@@ -9348,7 +9349,8 @@ spec:
                         type: array
                     type: object
                   registry:
-                    description: The configuration of Registry trait
+                    description: 'Deprecated: use jvm trait or read documentation.
+                      The configuration of Registry trait'
                     properties:
                       configuration:
                         description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml b/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml
@@ -7921,7 +7921,8 @@ spec:
                             type: array
                         type: object
                       registry:
-                        description: The configuration of Registry trait
+                        description: 'Deprecated: use jvm trait or read documentation.
+                          The configuration of Registry trait'
                         properties:
                           configuration:
                             description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml b/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml
@@ -7919,7 +7919,8 @@ spec:
                             type: array
                         type: object
                       registry:
-                        description: The configuration of Registry trait
+                        description: 'Deprecated: use jvm trait or read documentation.
+                          The configuration of Registry trait'
                         properties:
                           configuration:
                             description: 'Legacy trait configuration parameters. Deprecated:

diff --git a/pkg/trait/registry.go b/pkg/trait/registry.go
@@ -64,8 +64,17 @@ func (t *registryTrait) Configure(e *Environment) (bool, *TraitCondition, error)
 	if e.IntegrationKit == nil || !pointer.BoolDeref(t.Enabled, false) {
 		return false, nil, nil
 	}
-
-	return e.IntegrationKitInPhase(v1.IntegrationKitPhaseBuildSubmitted), nil, nil
+	enabled := e.IntegrationKitInPhase(v1.IntegrationKitPhaseBuildSubmitted)
+	if enabled {
+		condition := NewIntegrationCondition(
+			v1.IntegrationConditionTraitInfo,
+			corev1.ConditionTrue,
+			traitConfigurationReason,
+			"Registry trait is deprecated. It may be removed in future version. Read documentation to find alternatives (likely JVM trait).",
+		)
+		return true, condition, nil
+	}
+	return false, nil, nil
 }
 
 func (t *registryTrait) Apply(e *Environment) error {