Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename collection to microsoft.ad #10

Merged
merged 1 commit into from
Jan 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .azure-pipelines/azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ schedules:

variables:
- name: checkoutPath
value: ansible_collections/ansible/active_directory
value: ansible_collections/microsoft/ad
- name: coverageBranches
value: main
- name: pipelinesCoverage
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Ansible Collection: ansible.active_directory
# Ansible Collection: microsoft.ad

[![Build Status](https://dev.azure.com/ansible/ansible.active_directory/_apis/build/status/CI?branchName=main)](https://dev.azure.com/ansible/ansible.active_directory/_build/latest?definitionId=24&branchName=main)
[![codecov](https://codecov.io/gh/ansible-collections/ansible.active_directory/branch/main/graph/badge.svg)](https://codecov.io/gh/ansible-collections/ansible.active_directory)
[![Build Status](https://dev.azure.com/ansible/microsoft.ad/_apis/build/status/CI?branchName=main)](https://dev.azure.com/ansible/microsoft.ad/_build/latest?definitionId=24&branchName=main)
[![codecov](https://codecov.io/gh/ansible-collections/microsoft.ad/branch/main/graph/badge.svg)](https://codecov.io/gh/ansible-collections/microsoft.ad)

The `ansible.active_directory` collection includes the plugins supported by Ansible to help the management of Microsoft Active Directory.
The `microsoft.ad` collection includes the plugins supported by Ansible to help the management of Microsoft Active Directory.

## Ansible version compatibility

Expand All @@ -15,11 +15,11 @@ PEP440 is the schema used to describe the versions of Ansible.

## Collection Documentation

Browsing the [**latest** collection documentation](https://docs.ansible.com/ansible/latest/collections/ansible/active_directory) will show docs for the _latest version released in the Ansible package_ not the latest version of the collection released on Galaxy.
Browsing the [**latest** collection documentation](https://docs.ansible.com/ansible/latest/collections/microsoft/ad) will show docs for the _latest version released in the Ansible package_ not the latest version of the collection released on Galaxy.

Browsing the [**devel** collection documentation](https://docs.ansible.com/ansible/devel/collections/ansible/active_directory) shows docs for the _latest version released on Galaxy_.
Browsing the [**devel** collection documentation](https://docs.ansible.com/ansible/devel/collections/microsoft/ad) shows docs for the _latest version released on Galaxy_.

We also separately publish [**latest commit** collection documentation](https://ansible-collections.github.io/ansible.active_directory/branch/main/) which shows docs for the _latest commit in the `main` branch_.
We also separately publish [**latest commit** collection documentation](https://ansible-collections.github.io/microsoft.ad/branch/main/) which shows docs for the _latest commit in the `main` branch_.

If you use the Ansible package and don't update collections independently, use **latest**, if you install or update this collection directly from Galaxy, use **devel**. If you are looking to contribute, use **latest commit**.

Expand All @@ -29,18 +29,18 @@ If you use the Ansible package and don't update collections independently, use *

Before using the Active Directory collection, you need to install it with the `ansible-galaxy` CLI:

ansible-galaxy collection install ansible.active_directory
ansible-galaxy collection install microsoft.ad

You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format:

```yaml
collections:
- name: ansible.active_directory
- name: microsoft.ad
```

## Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [Ansible Active Directory collection repository](https://github.com/ansible-collections/ansible.active_directory). See [Contributing to Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html#contributing-maintained-collections) for details.
We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [Ansible Active Directory collection repository](https://github.com/ansible-collections/microsoft.ad). See [Contributing to Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html#contributing-maintained-collections) for details.

See [Developing modules for Windows](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general_windows.html#developing-modules-general-windows) for specifics on Windows modules.

Expand Down Expand Up @@ -79,9 +79,9 @@ The current process for publishing new versions of the Windows Core Collection i
* Create a release with the tag that matches the version number
* The tag is the version number itself, and should not start with anything
* This will trigger a build and publish the collection to AH and Galaxy
* The Zuul job progress will be listed [here](https://ansible.softwarefactory-project.io/zuul/builds?project=ansible-collections%2Fansible.active_directory&skip=0)
* The Zuul job progress will be listed [here](https://ansible.softwarefactory-project.io/zuul/builds?project=ansible-collections%2Fmicrosoft.ad&skip=0)

After the version is published, verify it exists on the [Active Directory Galaxy page](https://galaxy.ansible.com/ansible/active_directory).
After the version is published, verify it exists on the [Active Directory Galaxy page](https://galaxy.ansible.com/microsoft/ad).


## More Information
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
# SPDX-License-Identifier: GPL-3.0-or-later

edit_on_github:
repository: ansible-collections/ansible.active_directory
repository: ansible-collections/microsoft.ad
branch: main
path_prefix: ''

extra_links:
- description: Report an issue
url: https://github.com/ansible-collections/ansible.active_directory/issues/new/choose
url: https://github.com/ansible-collections/microsoft.ad/issues/new/choose

communication:
matrix_rooms:
Expand Down
22 changes: 11 additions & 11 deletions docs/docsite/rst/guide_attributes.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _ansible_collections.ansible.active_directory.docsite.guide_attributes:
.. _ansible_collections.microsoft.ad.docsite.guide_attributes:

****************
Attributes guide
Expand All @@ -10,7 +10,7 @@ A common use case for modules in this collection is to manage various Active Dir
:local:
:depth: 1

.. _ansible_collections.active_directory.docsite.guide_attributes.ldap_attributes:
.. _ansible_collections.microsoft.ad.docsite.guide_attributes.ldap_attributes:

LDAP Attributes
===============
Expand Down Expand Up @@ -79,7 +79,7 @@ The last example outputs::

This shows the ``sAMAccountName`` is a string that can only have 1 value. The ``o`` attribute is also a string but can store multiple values. The ``objectGUID`` is a byte array value that can only have 1 value and is also read only.

.. _ansible_collections.active_directory.docsite.guide_attributes.setting_attributes:
.. _ansible_collections.microsoft.ad.docsite.guide_attributes.setting_attributes:

Setting Attributes
==================
Expand All @@ -94,7 +94,7 @@ Each of these keys contain a dictionary value where the keys are the LDAP attrib

.. code-block:: yaml

- ansible.active_directory.user:
- microsoft.ad.user:
name: MyUser
state: present
attributes:
Expand All @@ -111,7 +111,7 @@ The ``add`` key can be used to ensure the LDAP attribute values specified are ad

.. code-block:: yaml

- ansible.active_directory.user:
- microsoft.ad.user:
name: MyUser
state: present
attributes:
Expand All @@ -132,7 +132,7 @@ To clear an attribute value, define the attribute under ``set`` and set the valu

.. code-block:: yaml

- ansible.active_directory.user:
- microsoft.ad.user:
name: MyUser
state: present
attributes:
Expand All @@ -145,7 +145,7 @@ To clear an attribute value, define the attribute under ``set`` and set the valu

This task will ensure the ``comment``, ``company``, and ``extensionName`` attributes are cleared of any value.

.. _ansible_collections.active_directory.docsite.guide_attributes.attribute_types:
.. _ansible_collections.microsoft.ad.docsite.guide_attributes.attribute_types:

Attribute Types
===============
Expand Down Expand Up @@ -184,7 +184,7 @@ This looks like the following:

.. code-block:: yaml

- ansible.active_directory.user:
- microsoft.ad.user:
name: MyUser
state: present
attributes:
Expand Down Expand Up @@ -215,7 +215,7 @@ As raw bytes cannot be expressed in YAML, to set an attribute with a byte array

.. code-block:: yaml

- ansible.active_directory.user:
- microsoft.ad.user:
name: MyUser
state: present
attributes:
Expand All @@ -240,7 +240,7 @@ Attributes with datetime values are technically integer values but represent a p

.. code-block:: yaml

- ansible.active_directory.user:
- microsoft.ad.user:
name: MyUser
state: present
attributes:
Expand Down Expand Up @@ -269,7 +269,7 @@ A security descriptor is stored as a byte array in the attribute but the ``secur

.. code-block:: yaml

- ansible.active_directory.user:
- microsoft.ad.user:
name: MyUser
state: present
attributes:
Expand Down
48 changes: 24 additions & 24 deletions docs/docsite/rst/guide_migration.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _ansible_collections.ansible.active_directory.docsite.guide_migration:
.. _ansible_collections.microsoft.ad.docsite.guide_migration:

***************
Migration guide
Expand All @@ -10,31 +10,31 @@ Some of the modules in this collection have come from the `ansible.windows colle
:local:
:depth: 1

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules:

Migrated Modules
================

The following modules have been migrated in some shape or form into this collection

* ``ansible.windows.win_domain`` -> ``ansible.active_directory.domain`` - :ref:`see here <ansible_collections.ansible.active_directory.docsite.guide_migration.migrated_modules.win_domain>`_
* ``ansible.windows.win_domain_controller`` -> ``ansible.active_directory.domain_controller`` - :ref:`see here <ansible_collections.ansible.active_directory.docsite.guide_migration.migrated_modules.win_domain_controller>`_
* ``ansible.windows.win_domain_membership`` -> ``ansible.active_directory.membership`` - :ref:`see here <ansible_collections.ansible.active_directory.docsite.guide_migration.migrated_modules.win_domain_membership>`_
* ``community.windows.win_domain_computer`` -> ``ansible.active_directory.computer`` - :ref:`see here <ansible_collections.ansible.active_directory.docsite.guide_migration.migrated_modules.win_domain_computer>`_
* ``community.windows.win_domain_object_info`` -> ``ansible.active_directory.object_info`` - :ref:`see here <ansible_collections.ansible.active_directory.docsite.guide_migration.migrated_modules.win_domain_object_info>`_
* ``community.windows.win_domain_ou`` -> ``ansible.active_directory.ou`` - :ref:`see here <ansible_collections.ansible.active_directory.docsite.guide_migration.migrated_modules.win_domain_ou>`_
* ``community.windows.win_domain_user`` -> ``ansible.active_directory.user`` - :ref:`see here <ansible_collections.ansible.active_directory.docsite.guide_migration.migrated_modules.win_domain_user>`_
* ``ansible.windows.win_domain`` -> ``microsoft.ad.domain`` - :ref:`see here <ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain>`_
* ``ansible.windows.win_domain_controller`` -> ``microsoft.ad.domain_controller`` - :ref:`see here <ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_controller>`_
* ``ansible.windows.win_domain_membership`` -> ``microsoft.ad.membership`` - :ref:`see here <ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_membership>`_
* ``community.windows.win_domain_computer`` -> ``microsoft.ad.computer`` - :ref:`see here <ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_computer>`_
* ``community.windows.win_domain_object_info`` -> ``microsoft.ad.object_info`` - :ref:`see here <ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_object_info>`_
* ``community.windows.win_domain_ou`` -> ``microsoft.ad.ou`` - :ref:`see here <ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_ou>`_
* ``community.windows.win_domain_user`` -> ``microsoft.ad.user`` - :ref:`see here <ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_user>`_

While these modules are mostly drop in place compatible there are some breaking changes that need to be considered. See each module entry for more information.

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules.win_domain:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain:

Module win_domain
-----------------

There are no known breaking changes and should work as a drop in replacement. The ``reboot`` option has been added to have the module handle any reboots that are needed instead of a separate ``ansible.windows.win_reboot`` task. Due to the operations involved with promoting a domain controller, it is highly recommended to use this option.

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules.win_domain_controller:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_controller:

Module win_domain_controller
----------------------------
Expand All @@ -45,7 +45,7 @@ The following options have been removed:

The ``reboot`` option has been added to have the module handle any reboots instead of a separate ``ansible.windows.win_reboot`` task. Due to the operations involved with promoting a domain controller, it is highly recommended to use this option.

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules.win_domain_membership:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_membership:

Module win_domain_membership
----------------------------
Expand All @@ -56,7 +56,7 @@ The following options have been removed:

The ``reboot`` option has been added to have the module handle any reboots instead of a separate ``ansible.windows.win_reboot`` task. Due to the operations involved with promoting a domain controller, it is highly recommended to use this option.

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules.win_domain_computer:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_computer:

Module win_domain_computer
--------------------------
Expand All @@ -67,18 +67,18 @@ The default for ``enabled`` is nothing, the group will still be enabled when cre

The option ``ou`` is now named ``path`` to match the standard set by other modules.

The options ``offline_domain_join`` and ``odj_blob_path`` has been removed. Use the new module ``ansible.active_directory.offline_join`` to generate the offline join blob. For example:
The options ``offline_domain_join`` and ``odj_blob_path`` has been removed. Use the new module ``microsoft.ad.offline_join`` to generate the offline join blob. For example:

.. code-block:: yaml

- name: create computer object
ansible.active_directory.computer:
microsoft.ad.computer:
name: MyComputer
state: present
register: computer_obj

- name: create offline blob
ansible.active_directory.offline_join:
microsoft.ad.offline_join:
identity: '{{ computer_obj.object_guid }}'
when: computer_obj is changed
register: offline_blob
Expand All @@ -88,14 +88,14 @@ The options ``offline_domain_join`` and ``odj_blob_path`` has been removed. Use
var: offline_blob.blob
when: computer_obj is changed

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules.win_domain_object_info:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_object_info:

Module win_domain_object_info
-----------------------------

There are no known breaking changes and should work as a drop in replacement.

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules.win_domain_ou:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_ou:

Module win_domain_ou
----------------------
Expand All @@ -112,27 +112,27 @@ The return values for ``win_domain_ou`` have also been simplified to only return
* ``distinguished_name`` - The Distinguished Name (``DN``) of the managed OU
* ``object_guid`` - The Object GUID of the managed OU

All other return values have been removed, use ``ansible.active_directory.object_info`` to get extra values if needed.
All other return values have been removed, use ``microsoft.ad.object_info`` to get extra values if needed.

.. _ansible_collections.active_directory.docsite.guide_migration.migrated_modules.win_domain_user:
.. _ansible_collections.microsoft.ad.docsite.guide_migration.migrated_modules.win_domain_user:

Module win_domain_user
----------------------

The following options have changed:

* ``attributes`` - changed format as outlined in :ref:`Attributes guid <ansible_collections.ansible.active_directory.docsite.guide_attributes>`_
* ``attributes`` - changed format as outlined in :ref:`Attributes guid <ansible_collections.microsoft.ad.docsite.guide_attributes>`_
* ``groups_action`` - ``replace`` has been renamed to ``set``
* ``spn_action`` - ``replace`` has been renamed to ``set``
* ``state`` - No query option - use ``ansible.active_directory.object_info`` instead
* ``state`` - No query option - use ``microsoft.ad.object_info`` instead
* ``enabled`` - Does not default to ``true``. Creating a new user without a password will use ``enable=false`` but setting a password will use ``enable=true``

The ``groups_action`` and ``spn_action`` ``set`` value was renamed to align with common practice. The ``state=query`` functionality has been removed to simplify the module and favour ``ansible.active_directory.object_info`` which is designed to return information about AD objects. The ``enabled`` default was removed to allow setting other attributes on an existing AD object without always having to specify ``enabled``.
The ``groups_action`` and ``spn_action`` ``set`` value was renamed to align with common practice. The ``state=query`` functionality has been removed to simplify the module and favour ``microsoft.ad.object_info`` which is designed to return information about AD objects. The ``enabled`` default was removed to allow setting other attributes on an existing AD object without always having to specify ``enabled``.

The return values for ``win_domain_user`` have also been simplified to only return:

* ``distinguished_name`` - The Distinguished Name (``DN``) of the managed user
* ``object_guid`` - The Object GUID of the managed user
* ``sid`` - The Security Identifier of the managed user

All other return values have been removed, use ``ansible.active_directory.object_info`` to get extra values if needed.
All other return values have been removed, use ``microsoft.ad.object_info`` to get extra values if needed.
12 changes: 6 additions & 6 deletions galaxy.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
namespace: ansible
name: active_directory
namespace: microsoft
name: ad
version: 0.1.0
readme: README.md
authors:
Expand All @@ -11,10 +11,10 @@ license_file: COPYING
tags:
- windows
dependencies: {}
repository: https://github.com/ansible-collections/ansible.active_directory
documentation: https://docs.ansible.com/ansible/devel/collections/ansible/active_directory
homepage: https://github.com/ansible-collections/ansible.active_directory
issues: https://github.com/ansible-collections/ansible.active_directory/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
repository: https://github.com/ansible-collections/microsoft.ad
documentation: https://docs.ansible.com/ansible/devel/collections/microsoft/ad
homepage: https://github.com/ansible-collections/microsoft.ad
issues: https://github.com/ansible-collections/microsoft.ad/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
build_ignore:
- .vscode
- tests/integration/inventory*
Expand Down
Loading