docs: Clarification of the create namespace feature (#11723)

* docs: Clarification of the create namespace feature Signed-off-by: Leonardo Luz Almeida <leonardo_almeida@intuit.com> * Address review suggestion Signed-off-by: Leonardo Luz Almeida <leonardo_almeida@intuit.com> Signed-off-by: Leonardo Luz Almeida <leonardo_almeida@intuit.com>
argoproj · Dec 16, 2022 · aaeef29 · aaeef29
1 parent 5fc009e
commit aaeef29
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/docs/user-guide/sync-options.md b/docs/user-guide/sync-options.md
@@ -266,10 +266,16 @@ The example above shows how an Argo CD Application can be configured so it will
 apiVersion: argoproj.io/v1alpha1
 kind: Application
 metadata:
-  namespace: test
+  namespace: argocd
 spec:
+  destination:
+    server: https://kubernetes.default.svc
+    namespace: some-namespace
   syncPolicy:
     syncOptions:
     - CreateNamespace=true
 ```
-The example above shows how an Argo CD Application can be configured so it will create namespaces for the Application resources if the namespaces don't exist already. Without this either declared in the Application manifest or passed in the cli via `--sync-option CreateNamespace=true`, the Application will fail to sync if the resources' namespaces do not exist.
+
+The example above shows how an Argo CD Application can be configured so it will create the namespace specified in `spec.destination.namespace` if it doesn't exist already. Without this either declared in the Application manifest or passed in the CLI via `--sync-option CreateNamespace=true`, the Application will fail to sync if the namespace doesn't exist.
+
+Note that the namespace to be created must be informed in the `spec.destination.namespace` field of the Application resource. The `metadata.namespace` field in the Application's child manifests must match this value, or can be omitted, so resources are created in the proper destination.